GetRoleTextA-Funktion (oleacc.h)

Artikel
11/20/2024

Ruft die lokalisierte Zeichenfolge ab, die die Rolle des Objekts für den angegebenen Rollenwert beschreibt.

Syntax

UINT GetRoleTextA(
  [in]  DWORD lRole,
  [out] LPSTR lpszRole,
  [in]  UINT  cchRoleMax
);

Parameter

[in] lRole

Typ: DWORD-

Eine der Objektrolle Konstanten.

[out] lpszRole

Typ: LPTSTR-

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

[in] cchRoleMax

Typ: UINT-

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

Rückgabewert

Typ: UINT-

Wenn lpszRole nichtNULL-ist, ist der Rückgabewert die Anzahl der Bytes (ANSI-Zeichenfolgen) oder Zeichen (Unicode-Zeichenfolgen), die in den Puffer kopiert wurden, nicht einschließlich des endenden NULL-Zeichens. Wenn lpszRole-NULL-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 lpszRole kein gültiger Zeiger ist, ist der Rückgabewert null (0). Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Anmerkung

Der oleacc.h-Header definiert GetRoleText als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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