WinCPICExtractEvent 函数为应用程序提供了一种方法,用于确定用于通信 (CPI-C) 会话的 Microsoft® Windows® 公共编程接口的事件句柄。
语法
VOID WINAPI WinCPICExtractEvent(
unsigned char FAR*conversation_ID,HANDLE FAR*event_handle, CM_INT32 FAR*return_code);
参数
conversation_ID
指定使用此事件的会话的标识符。 此参数由初始 Accept_Conversation 调用返回。
event_handle
返回的参数。 此会话正在使用的事件的句柄。 如果尚未注册句柄,则此参数返回 NULL。
return_code
从此调用返回的代码。 本主题后面列出了有效的返回代码。
返回代码
CM_OK
函数已成功执行。
CM_PROGRAM_PARAMETER_CHECK
传递给此函数的一个或多个参数无效。
注解
在非阻塞会话上发出谓词时,如果要异步完成,它将返回CM_OPERATION_INCOMPLETE。 如果事件已注册到会话中,则应用程序可以调用 WaitForSingleObject 或 WaitForMultipleObjects ,以通知谓词完成。 WinCPICExtractEvent 允许 CPI-C 应用程序确定此事件句柄。 谓词完成后,应用程序必须调用 Wait_For_Conversation来确定异步谓词的返回代码。 可以调用 Cancel_Conversation函数来取消操作和会话。
如果尚未注册任何事件,异步谓词将像目前一样完成,即将消息发布到应用程序已注册到 CPI-C 库的窗口。