dfGetExtraData Function
Summary
dfGetExtraData provides extracting of additional data which was saved in df-file when it was created.
Syntax
int dfGetExtraData (
TDfHandle hDf,
void * buffer,
size_t size,
size_t * pnCopied );
Arguments
hDf
[Input]
Special df-file descriptor, created by dfOpenDfFile function.
buffer
[Output]
Pointer on the memory area where additional data is written.
Can not be NULL.
size
[Input]
Size of the output buffer, on which the buffer parameter points on.
Can be smaller then the additional data size.
pnCopied
[Output]
Pointer on the variable, in which the number of bytes of additional data written in buffer is returned.
Can not be NULL.
Return Values
If the function succeeds, the return value is zero (EDF_SUCCESS).
If the function fails, the return value is one of the following:
- EDF_BAD_PARAM
- EDF_OUT_OF_MEMORY
- EDF_FATAL
- EDF_SYSERROR
- EDF_READ_ERROR
Remarks
If df-file does not contain additional data then this function returns EDF_SUCCESS and *pnCopied is "0".
|