GetUmsCompletionListEvent, fonction (winbase.h)

Récupère un handle de l’événement associé à la liste de saisie semi-automatique de planification en mode utilisateur (UMS) spécifiée.

Syntaxe

BOOL GetUmsCompletionListEvent(
  [in]      PUMS_COMPLETION_LIST UmsCompletionList,
  [in, out] PHANDLE              UmsCompletionEvent
);

Paramètres

[in] UmsCompletionList

Pointeur vers une liste de saisie semi-automatique UMS. La fonction CreateUmsCompletionList fournit ce pointeur.

[in, out] UmsCompletionEvent

Pointeur vers une variable HANDLE. À la sortie, le paramètre UmsCompletionEvent est défini sur un handle pour l’événement associé à la liste d’achèvement spécifiée.

Valeur retournée

Si la fonction réussit, elle retourne une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Le système signale un événement de liste d’achèvement UMS lorsque le système met en file d’attente des éléments vers une liste d’achèvement vide. Un handle d’événement de liste d’achèvement peut être utilisé avec n’importe quelle fonction d’attente qui prend un handle pour un événement. Lorsque l’événement est signalé, une application appelle généralement DequeueUmsCompletionListItems pour récupérer le contenu de la liste d’achèvement.

Le handle d’événement reste valide jusqu’à ce que sa liste d’achèvement soit supprimée. N’utilisez pas le handle d’événement pour attendre une liste de saisie semi-automatique qui a été supprimée ou qui est en cours de suppression.

Lorsque le handle n’est plus nécessaire, utilisez la fonction CloseHandle pour fermer le handle.

Configuration requise

Voir aussi

CreateUmsCompletionList

DequeueUmsCompletionListItems

Fonctions d’attente