WinCPICSetEvent
La fonction WinCPICSetEvent associe un handle d’événement à une saisie semi-verbale.
Syntaxe
VOID WINAPI WinCPICSetEvent(
unsigned char FAR* conversation_ID,HANDLE FAR* event_handle,
CM_INT32 FAR*return_code);
Paramètres
conversation_ID
Spécifie l’identificateur de la conversation pour laquelle cet événement est utilisé. Ce paramètre est retourné par l’appel initial Accept_Conversation .
event_handle
Handle de l’événement qui doit être effacé lorsqu’un verbe asynchrone sur la conversation se termine. Ce paramètre peut remplacer un événement déjà défini ou supprimer un événement déjà défini (en ayant NULL comme paramètre).
return_code
Code retourné par cet appel. Les codes de retour valides sont répertoriés plus loin dans cette rubrique.
Codes de retour
CM_OK
La fonction s’est exécutée avec succès.
CM_PROGRAM_PARAMETER_CHECK
Un ou plusieurs des paramètres passés à cette fonction ne sont pas valides.
CM_OPERATION_NOT_ACCEPTED
Cette valeur indique qu’une opération précédente sur cette conversation est incomplète et que l’appel WinCPICSetEvent n’a pas été accepté.
Remarques
Lorsqu’un verbe est émis sur une conversation non bloquante, il retourne CM_OPERATION_INCOMPLETE s’il doit se terminer de manière asynchrone. Si un événement a été inscrit dans la conversation, l’application peut appeler WaitForSingleObject ou WaitForMultipleObjects pour être informée de la fin du verbe. Une fois le verbe terminé, l’application doit appeler Wait_For_Conversationpour déterminer le code de retour du verbe asynchrone.
Il incombe à l’application de réinitialiser l’événement, comme c’est le cas avec d’autres API.