Funzione GetRoleTextA (oleacc.h)

Recupera la stringa localizzata che descrive il ruolo dell'oggetto per il valore del ruolo specificato.

Sintassi

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

Parametri

[in] lRole

Tipo: DWORD

Una delle costanti del ruolo oggetto .

[out] lpszRole

Tipo: LPTSTR

Indirizzo di un buffer che riceve la stringa di testo del ruolo. Se questo parametro è NULL, la funzione restituisce la lunghezza della stringa di ruolo, senza includere il carattere Null.

[in] cchRoleMax

Tipo: UINT

Dimensione del buffer a cui punta il parametro lpszRole . Per le stringhe ANSI, questo valore viene misurato in byte; per le stringhe Unicode, viene misurato in caratteri.

Valore restituito

Tipo: UINT

Se ha esito positivo e se lpszRole è diverso da NULL, il valore restituito è il numero di byte (stringhe ANSI) o caratteri (stringhe Unicode) copiati nel buffer, senza includere il carattere Null di terminazione. Se lpszRole è NULL, il valore restituito rappresenta la lunghezza della stringa, senza includere il carattere Null.

Se la risorsa stringa non esiste o se il parametro lpszRole non è un puntatore valido, il valore restituito è zero (0). Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Nota

L'intestazione oleacc.h definisce GetRoleText come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	oleacc.h
Libreria	Oleacc.lib
DLL	Oleacc.dll
Componente ridistribuibile	Accessibilità attiva 1.3 RDK in Windows NT 4.0 con SP6 e versioni successive e Windows 95