Platform SDK: Exchange Server

UpdateProgressTextProc

The file-based batch processing functions of the directory functions invoke a callback function based on the UpdateProgressTextProc prototype after processing each batch item.

Quick Info

Header file: DAPI.H
Library: DAPI.LIB
Unicode:  

BOOL (* UpdateProgressTextProc)(
  LPVOID lpvAppDefined,  
  LPTSTR pszText         
);
 

Parameters

lpvAppDefined
Points to an application-defined parameter.
pszText
Input parameter. Text describing progress.

Return Values

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

Remarks

The UpdateProgressTextProc function is similar to UpdateProgressProc, except that the callback function is passed a string describing the object being processed. The string can be used to update the progress display.

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

See Also

CALLBACKPROGRESS, EndProgressProc, InitProgressProc, ResetProgressProc, UpdateProgressProc