WinCPICSetEvent

The WinCPICSetEvent function associates an event handle with a verb completion.

VOID WINAPI WinCPICSetEvent(

Parameters

conversation_ID

Specifies the identifier for the conversation for which this event is used. This parameter is returned by the initial Accept_Conversation call.

event_handle

The handle of the event that is to be cleared when an asynchronous verb on the conversation completes. This parameter can replace an already-defined event or remove an already-defined event (by having NULL as the parameter).

return_code

The code returned from this call. The valid return codes are listed below.

Return Codes

cm_ok

The function executed successfully.

cm_program_parameter_check

One or more of the parameters passed to this function are invalid.

cm_operation_not_accepted

This value indicates that a previous operation on this conversation is incomplete and the WinCPICSetEvent call was not accepted.

Remarks

When a verb is issued on a nonblocking conversation, it returns CM_OPERATION_INCOMPLETE if it is going to complete asynchronously. If an event has been registered with the conversation, then the application can call WaitForSingleObject or WaitForMultipleObjects to be notified of the completion of the verb. When the verb has completed, the application must call Wait_for_Conversation to determine the return code for the asynchronous verb.

It is the responsibility of the application to reset the event, as it is with other APIs.

See Also

Cancel_Conversation