dfBuildN, dfBuildH Function

Summary

dfBuildN, dfBuildH functions are used to build a df-file based on the results of file comparing, presented by the comparing context.

Syntax

int dfBuildN (

PTDfCmp
pCmp,

_TCHAR const *
szDfFile,

TDfBldOptions *
pBldOpt,

TDfInteract *
pInteract );

int dfBuildH (

PTDfCmp
pCmp,

_TCHAR const *
hDfFile,

TDfBldOptions *
pBldOpt,

TDfInteract *
pInteract );

Arguments

pCmp

[Input]

Pointer on the comparing context.

szDfFile

[Input]

Name of the result df-file.

If specified file already exists then it is replaced.

hDfFile

[Input]

File descriptor, in which the result file is written. Previous file content will be lost.

Cannot be INVALID_FD_VALUE.

pBldOpt

[Input]

Pointer on the structure containing parameters of df-file building.

If NULL, then default parameters values are taken.

(See description of structure TDfBldOptions)

pInteract

[Input]

Pointer on the structure of interaction with application program (see description of the structure TDfInteract).

Can be set 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_OPEN_ERROR
• EDF_READ_ERROR
• EDF_WRITE_ERROR
• EDF_ABORTED
• EDF_DF_UNSUPP_COMPRESSOR

Remarks

dfBuildN and dfBuildH can be called immediately after context creation or after successful call of dfCompare.

If dfBuildN or dfBuildH are called after dfCompare terminates with an error, then EDF_BAD_PARAM is returned.