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

Requisiti