GetStateTextA-Funktion (oleacc.h)

Artikel
11/20/2024

Ruft eine lokalisierte Zeichenfolge ab, die den Status eines Objekts für ein einzelnes vordefiniertes Bit-Flag für den Zustand eines Objekts beschreibt. Da Statuswerte eine Kombination aus mindestens einer Bitkennzeichnung sind, rufen Clients diese Funktion mehrmals auf, um alle Statuszeichenfolgen abzurufen.

Syntax

UINT GetStateTextA(
  [in]  DWORD lStateBit,
  [out] LPSTR lpszState,
  [in]  UINT  cchState
);

Parameter

[in] lStateBit

Typ: DWORD-

Eine der Objektstatuskonstanten.

[out] lpszState

Typ: LPTSTR-

Adresse eines Puffers, der die Statustextzeichenfolge empfängt. Wenn dieser Parameter NULL-ist, gibt die Funktion die Länge der Statuszeichenfolge zurück, nicht einschließlich des Nullzeichens.

[in] cchState

Typ: UINT-

Die Größe des Puffers, auf den der parameter lpszStateBit verweist. Bei ANSI-Zeichenfolgen wird dieser Wert in Byte gemessen; für Unicode-Zeichenfolgen wird sie in Zeichen gemessen.

Rückgabewert

Typ: UINT-

Bei erfolgreicher Ausführung und wenn lpszStateBit nichtNULL-ist, ist der Rückgabewert die Anzahl der Bytes (ANSI-Zeichenfolgen) oder Zeichen (Unicode-Zeichenfolgen), die in den Puffer kopiert werden, nicht einschließlich des null-beendeten Zeichens. Wenn lpszStateBitNULL-ist, stellt der Rückgabewert die Länge der Zeichenfolge dar, nicht einschließlich des Nullzeichens.

Wenn die Zeichenfolgenressource nicht vorhanden ist oder der parameter lpszStateBit kein gültiger Zeiger ist, ist der Rückgabewert null (0). Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Diese Funktion akzeptiert jeweils nur einen Zustand, nicht eine Bitmaske.

Anmerkung

Der oleacc.h-Header definiert GetStateText als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	oleacc.h
Library	Oleacc.lib
DLL-	Oleacc.dll
redistributable	Active Accessibility 1.3 RDK unter Windows NT 4.0 mit SP6 und höher und Windows 95

Freigeben über