LIBDF Functions: dfOpenDfFile

Summary

 

dfOpenDfFile function is used to open existing df-file ant test its integrity.

 

Syntax

 

int dfOpenDfFile (

 

_TCHAR const *

szDfFile,

TDfHandle *

phDf );

 

Arguments

 

szDfFile

[Input]

Name of df-file.

 

phDf

[Output]

Pointer on the variable of type TDfHandle in which a special df-file descriptor is placed. This descriptor is valid only as a parameter in functions of LIBDF library.

 

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_OPEN_ERROR

EDF_READ_ERROR

EDF_DF_DAMAGED

EDF_DF_UNSUPP_VERSION

 

Remarks

After completion of the work with df-file it must be closed by dfCloseDfFile function call.

 

See also

dfCloseDfFile, dfGetDfInfo, dfApplyN, dfApplyN, dfTouch

 

Converted from CHM to HTML with chm2web Standard 2.75 (unicode)