Platform SDK: Exchange Server

SAD_ScGetBulkProxyStatus

The SAD_ScGetBulkProxyStatus function obtains the status of a bulk operation.

Quick Info

Header file: SADAPI.H
Library: SADAPI.LIB

RPC_SC SAD_ScGetBulkProxyStatus(
  LPTSTR szServer,                
  RPC_SYSTEMTIME * pstTimeStart,  
  DWORD * pdwTimeStart,           
  DWORD * pdwTimeCur,             
  INT * piRecipients,             
  INT * pcRecipients              
);
 

Parameters

szServer
Input parameter. The server where the bulk operation is running.
pstTimeStart
Output parameter. Points to an RPC_SYSTEMTIME structure containing the system time (day and year) when the bulk operation began. RPC_SYSTEMTIME is defined as follows:
        typedef struct  __MIDL_TriggerPrivateRPC_0001
            {
            short rgwSystemTime[ 8 ];
            }    RPC_SYSTEMTIME;
 
pdwTimeStart
Output parameter. The absolute time, in time_t format, when the bulk operation began.
pdwTimeCur
Output parameter. The absolute current time, in time_t format.
piRecipients
Output parameter. The index into the list of recipients where the bulk operation is working.
pcRecipients
Output parameter. The total number of recipients on which the bulk operation is working.

Return Values

See Return Values.

Remarks

The SAD_ScGetBulkProxyStatus function gets the status of whatever bulk operation is running. These bulk operations are SAD_ScBulkCreateProxy, SAD_ScBulkCreateMultiProxy, and SAD_ScBulkUpdateMultiProxy.

You can determine how long, in seconds, the bulk operation has been running by subtracting the value of pdwTimeStart from the value of pdwTimeCur.

You can tell how far along the bulk operation is in converting a list of recipients by comparing piRecipients, which gives you where the bulk operation is in the list, with pcRecipients , which tells you how many recipients are in the list.

You can use SAD_ScBulkProxyHalt to interrupt a bulk operation.

For more information on this function, see Generating Recipient Proxy Addresses.

See Also

SAD_ScBulkCreateMultiProxy, SAD_ScBulkCreateProxy, SAD_ScBulkProxyHalt, SAD_ScBulkUpdateMultiProxy