GetRoleTextA-Funktion (oleacc.h)

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

Anforderungen