Funzione StringCchGetsExW (strsafe.h)

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.

StringCchGetsEx aggiunge alla funzionalità di StringCchGets restituendo un puntatore alla fine della stringa di destinazione e il numero di caratteri rimasti 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 sostituisce fget, che non sostituisce i caratteri di nuova riga con un carattere Null di terminazione.

Sintassi

STRSAFEAPI StringCchGetsExW(
  [out]           STRSAFE_LPWSTR pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPWSTR *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 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.

[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, punta al carattere Null di terminazione alla fine della stringa.

[out, optional] pcchRemaining

Tipo: size_t*

Numero di caratteri inutilizzati in pszDest, incluso il carattere Null di terminazione. 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, viene usato il byte basso di dwFlags (0) per riempire la parte non inizializzata di pszDest dopo il carattere Null di terminazione.
STRSAFE_IGNORE_NULLS 0x00000100	Considerare puntatori a stringhe null come stringhe vuote (TEXT("")). Questo flag è utile per simulare funzioni come lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	Se la funzione ha esito negativo, viene usato il byte basso di dwFlags (0) per riempire l'intero buffer pszDest e il buffer viene terminato con null. In caso di errore STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa troncata restituita viene sovrascritta.
STRSAFE_NULL_ON_FAILURE 0x00000800	Se la funzione non riesce, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore 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("")). In caso di errore STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa troncata viene sovrascritta.

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 caratteri 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 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.

Osservazioni

StringCchGetsEx 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. StringCchGetsEx termina sempre un buffer di destinazione diverso da zero.

Il valore di pszDest non deve essere null a meno che non venga specificato il flag di STRSAFE_IGNORE_NULLS. Tuttavia, è possibile che venga restituito un errore dovuto a spazio insufficiente anche se valori null vengono ignorati.

StringCchGetsEx 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	Valore letterale stringa	Funzione
char	"string"	StringCchGetsExA
TCHAR	TEXT("string")	StringCchGetsEx
WCHAR	L"string"	StringCchGetsExW

 

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