GetClusterNotifyV2-Funktion (clusapi.h)

Artikel
02/24/2024

Ruft Informationen zum nächsten Benachrichtigungsereignis für einen Benachrichtigungsport ab.

Syntax

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
);

Parameter

[in] hChange

Ein Handle für den Benachrichtigungsport. Dieses Handle wird von der CreateClusterNotifyPortV2-Funktion erstellt.

[out] lpdwNotifyKey

Ein Zeiger auf den Benachrichtigungsschlüssel für den Benachrichtigungsport.

[in, out, optional] pFilterAndType

Ein Zeiger auf eine NOTIFY_FILTER_AND_TYPE Struktur, die das nächste Benachrichtigungsereignis für den Benachrichtigungsport beschreibt.

[in, out, optional] buffer

Ein Zeiger auf einen Puffer für das Benachrichtigungsereignis.

[in, out, optional] lpbBufferSize

Ein Zeiger auf die Größe des Pufferparameters in Bytes.

[in, out, optional] lpszObjectId

Ein Zeiger auf eine Unicode-Zeichenfolge mit der ID des Clusterobjekts, das das Ereignis ausgelöst hat. Die Zeichenfolge endet mit einem endenden NULL-Zeichen.

[in, out, optional] lpcchObjectId

Bei der Eingabe ein Zeiger auf ein DWORD , der die maximale Anzahl von Zeichen angibt, die der lpszObjectId-Parameter enthalten kann, einschließlich des abschließenden NULL-Zeichens. In der Ausgabe ein Zeiger auf ein DWORD , der die Anzahl der Zeichen angibt, die lpszObjectId empfangen hat, mit Ausnahme des abschließenden NULL-Zeichens.

[in, out, optional] lpszParentId

Ein Zeiger auf eine Unicode-Zeichenfolge mit der ID des übergeordneten Objekts zum Clusterobjekt, das das Ereignis ausgelöst hat. Die Zeichenfolge endet mit einem endenden NULL-Zeichen.

[in, out, optional] lpcchParentId

Bei der Eingabe ein Zeiger auf ein DWORD , der die maximale Anzahl von Zeichen angibt, die der parameter lpszParentId enthalten kann, einschließlich des abschließenden NULL-Zeichens. In der Ausgabe ein Zeiger auf ein DWORD , der die Anzahl der Zeichen angibt, die lpszParentId empfangen hat, mit Ausnahme des abschließenden NULL-Zeichens.

[in, out, optional] lpszName

Ein Zeiger auf eine Unicode-Zeichenfolge, die den Namen des Clusterobjekts enthält, das das Ereignis ausgelöst hat. Die Zeichenfolge endet mit einem endenden NULL-Zeichen.

[in, out, optional] lpcchName

Bei der Eingabe ein Zeiger auf ein DWORD , der die maximale Anzahl von Zeichen angibt, die der parameter lpszName enthalten kann, einschließlich des abschließenden NULL-Zeichens. In der Ausgabe ein Zeiger auf ein DWORD , der die Anzahl der Zeichen angibt, die lpszName empfangen hat, mit Ausnahme des abschließenden NULL-Zeichens.

[in, out, optional] lpszType

Ein Zeiger auf eine Unicode-Zeichenfolge, die den Typ des Clusterobjekts enthält, das das Ereignis ausgelöst hat. Die Zeichenfolge endet mit einem endenden NULL-Zeichen.

[in, out, optional] lpcchType

Bei der Eingabe ein Zeiger auf ein DWORD , der die maximale Anzahl von Zeichen angibt, die der lpszType-Parameter enthalten kann, einschließlich des abschließenden NULL-Zeichens. In der Ausgabe ein Zeiger auf ein DWORD , der die Anzahl der Zeichen angibt, die lpszType empfangen hat, mit Ausnahme des abschließenden NULL-Zeichens.

[in, optional] dwMilliseconds

Ein Timeoutwert, der angibt, wie lange der Aufrufer bereit ist, auf die Benachrichtigung zu warten.

Rückgabewert

Wenn der Vorgang erfolgreich ist, gibt diese Funktion ERROR_SUCCESS zurück.

Wenn der Vorgang fehlschlägt, gibt diese Funktion einen der folgenden Systemfehlercodes zurück.

Rückgabecode/-wert	BESCHREIBUNG
ERROR_INVALID_HANDLE 6	Das Handle, das im hChange-Parameter dargestellt wird, ist ungültig oder wurde von einem anderen Thread geschlossen.
WAIT_TIMEOUT 258 (0x102)	Für den Anruf ist ein Timeout aufgetreten, bevor die Benachrichtigung erfolgreich zurückgegeben werden konnte.
ERROR_MORE_DATA 234 (0xEA)	Der Puffer, auf den der parameter lpszName verweist, ist nicht groß genug, um das Ergebnis zu enthalten. Der Parameter lpcchName gibt die Anzahl der Zeichen im Ergebnis zurück, wobei das abschließende NULL-Zeichen ausgeschlossen wird.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows Server 2012
Zielplattform	Windows
Kopfzeile	clusapi.h
Bibliothek	ClusAPI.lib
DLL	ClusAPI.dll

Weitere Informationen

Failoverclusterverwaltungsfunktion

Freigeben über