Funzione GetStateTextA (oleacc.h)

Recupera una stringa localizzata che descrive lo stato di un oggetto per un singolo flag di bit di stato predefinito. Poiché i valori di stato sono una combinazione di uno o più flag di bit, i client chiamano questa funzione più volte per recuperare tutte le stringhe di stato.

Sintassi

UINT GetStateTextA(
  [in]  DWORD lStateBit,
  [out] LPSTR lpszState,
  [in]  UINT  cchState
);

Parametri

[in] lStateBit

Tipo: DWORD

Una delle costanti di stato dell'oggetto.

[out] lpszState

Tipo: LPTSTR

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

[in] cchState

Tipo: UINT

Dimensioni del buffer a cui punta il parametro lpszStateBit . 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 lpszStateBit è diverso da NULL, il valore restituito è il numero di byte (stringhe ANSI) o caratteri (stringhe Unicode) copiati nel buffer, non incluso il carattere con terminazione Null. Se lpszStateBit è NULL, il valore restituito rappresenta la lunghezza della stringa, senza includere il carattere Null.

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

Commenti

Questa funzione accetta un solo bit di stato alla volta, non una maschera di bit.

Nota

L'intestazione oleacc.h definisce GetStateText 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

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