GetStateTextA-Funktion (oleacc.h)

  • Artikel

Ruft eine lokalisierte Zeichenfolge ab, die den Zustand eines Objekts für ein einzelnes vordefiniertes Zustandsbitflag beschreibt. Da Zustandswerte eine Kombination aus mindestens einem Bitflag sind, rufen Clients diese Funktion mehrmals auf, um alle Zustandszeichenfolgen abzurufen.

Syntax

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

Parameter

[in] lStateBit

Typ: DWORD

Eine der Objektzustandskonstanten.

[out] lpszState

Typ: LPTSTR

Adresse eines Puffers, der die Zustandstextzeichenfolge empfängt. Wenn dieser Parameter NULL ist, gibt die Funktion die Länge der Zustandszeichenfolge zurück, ohne das NULL-Zeichen.

[in] cchState

Typ: UINT

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

Rückgabewert

Typ: UINT

Bei erfolgreicher Ausführung und wenn lpszStateBit nicht NULL ist, ist der Rückgabewert die Anzahl der Bytes (ANSI-Zeichenfolgen) oder Zeichen (Unicode-Zeichenfolgen), die in den Puffer kopiert werden, ohne das null-beendete Zeichen einzuschließt. Wenn lpszStateBitNULL ist, stellt der Rückgabewert die Länge der Zeichenfolge dar, ohne das NULL-Zeichen.

Wenn die Zeichenfolgenressource nicht vorhanden ist oder der lpszStateBit-Parameter kein gültiger Zeiger ist, ist der Rückgabewert null (0). Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Diese Funktion akzeptiert nur ein Zustandsbit gleichzeitig, keine Bitmaske.

Hinweis

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 nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile oleacc.h
Bibliothek Oleacc.lib
DLL Oleacc.dll
Verteilbare Komponente Active Accessibility 1.3 RDK unter Windows NT 4.0 mit SP6 und höher und Windows 95