Gets one line of text from stdin, up to and including the newline character ('\n'). The line of text is copied to the destination buffer, and the newline character is replaced with a null character. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer.
StringCbGetsEx adds to the functionality of StringCbGets by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.
StringCbGetsEx is a replacement for the following functions:
StringCbGetsEx is not a replacement for fgets, which does not replace newline characters with a terminating null character.
HRESULT StringCbGetsEx( _Out_ LPTSTR pszDest, _In_ size_t cbDest, _Out_opt_ LPTSTR *ppszDestEnd, _Out_opt_ size_t *pcbRemaining, _In_ DWORD dwFlags );
- pszDest [out]
The destination buffer, which is to receive the input.
- cbDest [in]
The size of the destination buffer, in bytes. This value must be greater than
sizeof(TCHAR)for the function to succeed. The maximum number of bytes allowed is
STRSAFE_MAX_CCH * sizeof(TCHAR). If cbDest is too small to hold the full line of text, the data is truncated.
- ppszDestEnd [out, optional]
The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string.
- pcbRemaining [out, optional]
The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned.
- dwFlags [in]
One or more of the following values.
If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character.
Treat NULL string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as lstrcpy.
If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten.
If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten.
As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten.
Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated.
The value in cbDest is larger than the maximum allowed value or an invalid flag was passed.
The value in cbDest is 1 or less.
Note that this function returns an HRESULT value, unlike the functions that it replaces.
StringCbGetsEx provides additional processing for proper buffer handling in your code. Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCbGetsEx always null-terminates a nonzero-length destination buffer.
The value of pszDest should not be NULL unless the STRSAFE_IGNORE_NULLS flag is specified. However, an error due to insufficient space may still be returned even though NULL values are ignored.
StringCbGetsEx can be used in its generic form, or in its more specific forms. The data type of the string determines the form of this function that you should use, as shown in the following table.
|String Data Type||String Literal||Function|
Minimum supported client
|Windows XP with SP2 [desktop apps | Windows Store apps]|
Minimum supported server
|Windows Server 2003 with SP1 [desktop apps | Windows Store apps]|
Unicode and ANSI names
|StringCbGetsExW (Unicode) and StringCbGetsExA (ANSI)|