InitProgressProc

The file-based batch processing functions of the directory access functions invoke a progress callback function based on the InitProgressProc prototype to initialize a user-defined progress display.

Quick Info

Header file: DAPI.H
Library: DAPI.LIB 

BOOL (* InitProgressProc)(
  LPVOID lpvAppDefined,  
  INT nMac               
);

Parameters

lpvAppDefined
Points to an application-defined parameter supplied in the CALLBACKPROGRESS structure member of the *_PARMS structure argument to the batch function.
nMac
Input parameter. The number of items to process, and the number of times to call the UpdateProgressProc function. If 0 (zero), which usually only occurs in the BatchExport or NWExport function, there are an unknown number of items to process.

Return Values

Return FALSE if the user cancels the operation; otherwise, return TRUE.

Remarks

You should allocate any memory or resources you need and display your dialog box or custom control in InitProgressProc.

If nMac is 0, the display shows only that n items have been processed, as opposed to showing the progress as a portion of the total processing to be performed.

If nMac is 50, for example, and if the application displays a progress bar that is 500 pixels across, the display width could be broken into increments of 10 pixels, to have the display updated each time the UpdateProgressProc function is called.

For more information on this function, see Using Directory Access Functions.

See Also

BatchExport, BatchImport, BEXPORT_PARMS, BIMPORT_PARMS, CALLBACKPROGRESS, EndProgressProc, NTExport, NTEXPORT_PARMS, NWExport, NWEXPORT_PARMS, ResetProgressProc, UpdateProgressProc