Funzione StringCchGetsA (strsafe.h)

Articolo
03/15/2023

Ottiene una riga di testo da stdin, fino al 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.

StringCchGets è una sostituzione delle funzioni seguenti:

ottiene, _getws, _getts

StringCchGets non è una sostituzione per fgets, che non sostituisce i caratteri di nuova riga con un carattere Null di terminazione.

Sintassi

STRSAFEAPI StringCchGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cchDest
);

Parametri

[out] pszDest

Tipo: LPTSTR

Buffer di destinazione, che riceve i caratteri copiati.

[in] cchDest

Tipo: size_t

Dimensioni del buffer di destinazione, in caratteri. Questo valore deve essere almeno 2 affinché la funzione abbia esito positivo. Il numero massimo di caratteri consentiti, incluso il carattere Null di terminazione, è STRSAFE_MAX_CCH. Se cchDest è 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. È consigliabile utilizzare le macro SUCCEEDED e FAILED per testare il valore restituito di questa funzione.

Codice restituito	Descrizione
S_OK	I caratteri sono stati letti da stdin, sono stati copiati nel buffer in pszDest e il buffer è stato terminato 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 cchDest è maggiore del valore massimo consentito.
STRSAFE_E_INSUFFICIENT_BUFFER	Il valore in cchDest è 1 o minore.

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

Commenti

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

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

StringCchGets può essere usato nel formato generico o nei moduli più specifici. Il tipo di dati della stringa determina la forma di questa funzione da usare, come illustrato nella tabella seguente.

Tipo di dati String	Stringhe letterali	Funzione
char	"stringa"	StringCchGetsA
TCHAR	TEXT("string")	StringCchGets
WCHAR	L"string"	StringCchGetsW

Nota

L'intestazione strsafe.h definisce StringCchGets 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 XP con SP2 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2003 con SP1 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	strsafe.h

Vedi anche

Riferimento

StringCbGets

StringCchGetsEx

Condividi tramite