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ù di una volta 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 dello stato dell'oggetto .

[out] lpszState

Tipo: LPTSTR

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

[in] cchState

Tipo: UINT

Dimensione 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 non è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 ottenere informazioni estese sull'errore, chiamare GetLastError.

Osservazioni

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

Fabbisogno