CALLBACKPROGRESS

The CALLBACKPROGRESS structure contains information that is used by the calling application to display a progress indicator.

Quick Info

typedef struct
{
  DWORD                      dwFlags;
  LPVOID                     lpvAppDefined;
  PDAPI_FInitProgress        pfnInitProgress;
  PDAPI_FUpdateProgress      pfnUpdateProgress;
  PDAPI_FEndProgress         pfnEndProgress;
  PDAPI_FResetProgress       pfnResetProgress;
  PDAPI_FUpdateProgressText  pfnUpdateProgressText;
}  CALLBACKPROGRESS, *PCALLBACKPROGRESS;
 

Members

dwFlags

Defined values that control the callback operations. Use the bitwise OR operator (|) to enable multiple operations:

DAPI_CALLBACK_CHAIN

Calls the default callback routine after calling the caller-supplied callback routine, unless the caller-supplied callback routine returns FALSE, which indicates that the operation was canceled.

lpvAppDefined

Application-defined field, passed as a parameter to the callback.

pfnInitProgress

Points to the function based on the InitProgressProc function prototype.

pfnUpdateProgress

Points to a function that initializes the user-defined progress display. For additional information, see the UpdateProgressProc function prototype.

pfnEndProgress

Points to a function that dismisses the update dialog box or exits when a fatal condition in the processing has been encountered. For additional information, see the EndProgressProc function prototype.

pfnResetProgress

Points to a function that resets the user-defined progress display when a new stage of the batch operation has started. For additional information, see the ResetProgressProc function prototype.

pfnUpdateProgressText

Points to a function that displays text to the user about the batch operation. For additional information, see the UpdateProgressTextProc function prototype.

Remarks

Directory functions can sometimes take a lot of time to execute because they are performing actions on large numbers of items. During this execution time, the calling application can display the operation's progress several ways. The default progress display is a modeless dialog box that the application can override by using the callback progress functionality. The application can also use the CALLBACKPROGRESS structure and display its own progress indicator by using functions based on the definitions of the EndProgressProc, InitProgressProc, ResetProgressProc, UpdateProgressProc, and UpdateProgressTextProc function prototypes.

For additional information on this structure, see Using Directory Access Functions.

See Also

EndProgressProc, InitProgressProc, ResetProgressProc, UpdateProgressProc, UpdateProgressTextProc