GetClusterNotifyV2, fonction (clusapi.h)

Article
08/22/2023

Récupère des informations sur l’événement de notification suivant pour un port de notification.

Syntaxe

DWORD GetClusterNotifyV2(
  [in]                HCHANGE                 hChange,
  [out]               DWORD_PTR               *lpdwNotifyKey,
  [in, out, optional] PNOTIFY_FILTER_AND_TYPE pFilterAndType,
  [in, out, optional] BYTE                    *buffer,
  [in, out, optional] LPDWORD                 lpbBufferSize,
  [in, out, optional] LPWSTR                  lpszObjectId,
  [in, out, optional] LPDWORD                 lpcchObjectId,
  [in, out, optional] LPWSTR                  lpszParentId,
  [in, out, optional] LPDWORD                 lpcchParentId,
  [in, out, optional] LPWSTR                  lpszName,
  [in, out, optional] LPDWORD                 lpcchName,
  [in, out, optional] LPWSTR                  lpszType,
  [in, out, optional] LPDWORD                 lpcchType,
  [in, optional]      DWORD                   dwMilliseconds
);

Paramètres

[in] hChange

Handle vers le port de notification. Ce handle est créé par la fonction CreateClusterNotifyPortV2 .

[out] lpdwNotifyKey

Pointeur vers la clé de notification pour le port de notification.

[in, out, optional] pFilterAndType

Pointeur vers une structure de NOTIFY_FILTER_AND_TYPE qui décrit l’événement de notification suivant pour le port de notification.

[in, out, optional] buffer

Pointeur vers une mémoire tampon pour l’événement de notification.

[in, out, optional] lpbBufferSize

Pointeur vers la taille du paramètre de mémoire tampon , en octets.

[in, out, optional] lpszObjectId

Pointeur vers une chaîne Unicode avec l’ID de l’objet de cluster qui a déclenché l’événement. La chaîne se termine par un caractère null de fin.

[in, out, optional] lpcchObjectId

En entrée, pointeur vers un DWORD qui spécifie le nombre maximal de caractères que le paramètre lpszObjectId peut contenir, y compris le caractère null de fin. En sortie, pointeur vers un DWORD qui spécifie le nombre de caractères reçus par lpszObjectId , à l’exclusion du caractère null de fin.

[in, out, optional] lpszParentId

Pointeur vers une chaîne Unicode avec l’ID du parent vers l’objet de cluster qui a déclenché l’événement. La chaîne se termine par un caractère null de fin.

[in, out, optional] lpcchParentId

En entrée, un pointeur vers un DWORD qui spécifie le nombre maximal de caractères que le paramètre lpszParentId peut contenir, y compris le caractère null de fin. En sortie, pointeur vers un DWORD qui spécifie le nombre de caractères reçus par lpszParentId , à l’exclusion du caractère null de fin.

[in, out, optional] lpszName

Pointeur vers une chaîne Unicode qui contient le nom de l’objet de cluster qui a déclenché l’événement. La chaîne se termine par un caractère null de fin.

[in, out, optional] lpcchName

En entrée, pointeur vers un DWORD qui spécifie le nombre maximal de caractères que le paramètre lpszName peut contenir, y compris le caractère null de fin. En sortie, pointeur vers un DWORD qui spécifie le nombre de caractères reçus par lpszName , à l’exclusion du caractère null de fin.

[in, out, optional] lpszType

Pointeur vers une chaîne Unicode qui contient le type d’objet de cluster qui a déclenché l’événement. La chaîne se termine par un caractère null de fin.

[in, out, optional] lpcchType

En entrée, un pointeur vers un DWORD qui spécifie le nombre maximal de caractères que le paramètre lpszType peut contenir, y compris le caractère null de fin. En sortie, pointeur vers un DWORD qui spécifie le nombre de caractères reçus par lpszType , à l’exclusion du caractère null de fin.

[in, optional] dwMilliseconds

Valeur de délai d’attente qui spécifie la durée pendant laquelle l’appelant est prêt à attendre la notification.

Valeur retournée

si l’opération réussit, cette fonction retourne ERROR_SUCCESS.

Si l’opération échoue, cette fonction retourne l’un des codes d’erreur système suivants.

Code/valeur de retour	Description
ERROR_INVALID_HANDLE 6	Le handle représenté dans le paramètre hChange n’est pas valide ou a été fermé par un autre thread.
WAIT_TIMEOUT 258 (0x102)	L’appel a expiré avant que la notification puisse être retournée.
ERROR_MORE_DATA 234 (0xEA)	La mémoire tampon pointée vers le paramètre lpszName n’est pas assez grande pour contenir le résultat. Le paramètre lpcchName retourne le nombre de caractères dans le résultat, à l’exclusion du caractère null de fin.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2012
Plateforme cible	Windows
En-tête	clusapi.h
Bibliothèque	ClusAPI.lib
DLL	ClusAPI.dll

Voir aussi

Fonction de gestion du cluster de basculement

Partager via