Funzione StringCbGetsA (strsafe.h)

Articolo
11/20/2024

Ottiene una riga di testo da stdin, fino a e includendo il carattere di nuova riga ('\n'). La riga di testo viene copiata nel buffer di destinazione e il carattere di nuova riga viene sostituito con un carattere Null. Le dimensioni del buffer di destinazione vengono fornite alla funzione per assicurarsi che non venga scritto oltre la fine del buffer.

Nota Questa funzione può essere usata solo inline.

stringCbGets è una sostituzione delle funzioni seguenti:

ottiene, _getws, _getts

StringCbGets non sostituisce fget, che non sostituisce i caratteri di nuova riga con un carattere Null di terminazione.

Sintassi

STRSAFEAPI StringCbGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cbDest
);

Parametri

[out] pszDest

Tipo: LPTSTR

Buffer di destinazione, che riceve l'input.

[in] cbDest

Tipo: size_t

Dimensioni del buffer di destinazione, in byte. Questo valore deve essere maggiore di sizeof(TCHAR) affinché la funzione abbia esito positivo. Il numero massimo di byte consentiti è STRSAFE_MAX_CCH * sizeof(TCHAR). Se cbDest è troppo piccolo per contenere la riga di testo completa, i dati vengono troncati.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. Per testare il valore restituito di questa funzione, è consigliabile utilizzare il SUCCEEDED e MACRO FAILED.

Codice restituito	Descrizione
S_OK	I dati sono stati letti da stdin, sono stati copiati nel buffer in pszDeste il buffer è stato terminato con null.
STRSAFE_E_END_OF_FILE	Indica un errore o una condizione di fine del file. Utilizzare feof o ferror per determinare quale si è verificato.
STRSAFE_E_INVALID_PARAMETER	Il valore in cbDest è maggiore del valore massimo consentito.
STRSAFE_E_INSUFFICIENT_BUFFER	Il valore in cbDest è `sizeof(TCHAR)` o minore.

Si noti che questa funzione restituisce un valore HRESULT, a differenza delle funzioni sostituite.

Osservazioni

stringCbGets fornisce un'elaborazione aggiuntiva per una corretta gestione del buffer nel codice. La gestione del buffer insufficiente è implicata in molti problemi di sicurezza che comportano sovraccarichi del buffer. StringCbGets termina sempre un buffer di destinazione diverso da zero.

Il valore di pszDest non deve essere NULL. Vedere StringCbGetsEx se è necessaria la gestione dei valori del puntatore di stringa Null.

StringCbGets può essere usato nel formato generico o nelle relative forme più specifiche. Il tipo di dati della stringa determina la forma di questa funzione da usare, come illustrato nella tabella seguente.

Tipo di dati String	Valore letterale stringa	Funzione
char	"string"	StringCbGetsA
TCHAR	TEXT("string")	StringCbGets
WCHAR	L"string"	StringCbGetsW

Nota

L'intestazione strsafe.h definisce StringCbGets 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 non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows XP con SP2 [app desktop \| App UWP]
server minimo supportato	Windows Server 2003 con SP1 [app desktop \| App UWP]
piattaforma di destinazione	Finestre
intestazione	strsafe.h

Vedere anche

riferimento

StringCbGetsEx

StringCchGets

Condividi tramite