Funzione StringCchGetsExA (strsafe.h)

Articolo
03/05/2024

Ottiene una riga di testo da stdin, fino a e incluso il carattere newline ('\n'). La riga di testo viene copiata nel buffer di destinazione e il carattere 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.

StringCchGetsEx aggiunge alla funzionalità StringCchGets restituendo un puntatore alla fine della stringa di destinazione e al numero di caratteri lasciati inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.

StringCchGetsEx è una sostituzione delle funzioni seguenti:

ottiene, _getws, _getts

StringCchGetsEx non è una sostituzione per fget, che non sostituisce i caratteri di nuova riga con un carattere null terminante.

Sintassi

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

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 per l'esito positivo della funzione. Il numero massimo di caratteri consentiti, incluso il carattere Null terminante, è STRSAFE_MAX_CCH. Se cchDest è troppo piccolo per contenere la riga completa di testo, i dati vengono troncati.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

Indirizzo di un puntatore alla fine di pszDest. Se ppszDestEnd non è NULL e tutti i dati vengono copiati nel buffer di destinazione, questo punta al carattere Null terminante alla fine della stringa.

[out, optional] pcchRemaining

Tipo: size_t*

Numero di caratteri inutilizzati in pszDest, incluso il carattere null terminante. Se pcchRemaining è NULL, il conteggio non viene mantenuto o restituito.

[in] dwFlags

Tipo: DWORD

Uno o più dei valori seguenti.

Valore	Significato
STRSAFE_FILL_BEHIND_NULL 0x00000200	Se la funzione ha esito positivo, il byte basso di dwFlags (0) viene usato per riempire la parte non inizializzata di pszDest seguendo il carattere null terminante.
STRSAFE_IGNORE_NULLS 0x00000100	Trattare i puntatori di stringa NULL come stringhe vuote (TEXT("")). Questo flag è utile per simulare funzioni come lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	Se la funzione ha esito negativo, il byte basso di dwFlags (0) viene usato per riempire l'intero buffer pszDest e il buffer viene terminato con null. Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata restituita viene sovrascritto.
STRSAFE_NULL_ON_FAILURE 0x00000800	Se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta.
STRSAFE_NO_TRUNCATION 0x00001000	Come nel caso di STRSAFE_NULL_ON_FAILURE, se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. È consigliabile usare le macro SUCCESSED 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 end-of-file. Usare feof o ferror per determinare quale si è verificato.
STRSAFE_E_INVALID_PARAMETER	Il valore in cchDest è maggiore del valore massimo consentito o è stato passato un flag non valido.
STRSAFE_E_INSUFFICIENT_BUFFER	Il valore in cchDest è 1 o minore.

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

Commenti

StringCchGetsEx offre un'elaborazione aggiuntiva per la corretta gestione del buffer nel codice. La gestione del buffer insufficiente è implicata in molti problemi di sicurezza che comportano l'overrun del buffer. StringCchGetsEx termina sempre null-termina un buffer di destinazione diverso da zero.

Il valore di pszDest non deve essere NULL a meno che non sia specificato il flag di STRSAFE_IGNORE_NULLS . Tuttavia, un errore dovuto a spazio insufficiente può essere restituito anche se i valori NULL vengono ignorati.

StringCchGetsEx può essere usato nel formato generico o nelle 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	Stringhe letterali	Funzione
char	"stringa"	StringCchGetsExA
TCHAR	TEXT("string")	StringCchGetsEx
WCHAR	L"string"	StringCchGetsExW

Nota

L'intestazione strsafe.h definisce StringCchGetsEx come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.

Requisiti

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	Windows
Intestazione	strsafe.h

Vedi anche

Riferimento

StringCbGetsEx

StringCchGets

Condividi tramite