GetRoleTextW-Funktion (oleacc.h)

  • Artikel

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

Syntax

UINT GetRoleTextW(
  [in]  DWORD  lRole,
  [out] LPWSTR lpszRole,
  [in]  UINT   cchRoleMax
);

Parameter

[in] lRole

Typ: DWORD

Eine der Objektrollenkonstanten .

[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, ohne das NULL-Zeichen.

[in] cchRoleMax

Typ: UINT

Die Größe des Puffers, auf den der lpszRole-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 lpszRole nicht NULL ist, ist der Rückgabewert die Anzahl der Bytes (ANSI-Zeichenfolgen) oder Zeichen (Unicode-Zeichenfolgen), die in den Puffer kopiert wurden, ohne das abschließende NULL-Zeichen. Wenn lpszRoleNULL ist, stellt der Rückgabewert die Länge der Zeichenfolge dar, ohne das NULL-Zeichen.

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

Hinweise

Hinweis

Der oleacc.h-Header definiert GetRoleText 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