StringCbGets (Windows CE 5.0)
Developing an Application > Safe String Functions > Safe String Reference > StrSafe.h Byte-Count Functions
This function is a replacement for gets.
The size, in bytes, of the destination buffer is provided to the function to ensure that StringCbGets does not write past the end of this buffer. It retrieves one line of text from stdin, a newline ('\n') ending the input. The line of text is copied to the destination buffer, and the carriage return is replaced with a null character.
**Note **This function can only be used inline.
HRESULT StringCbGets( LPTSTR pszDest,
size_t cbDest
);
Parameters
pszDest
[out] Pointer to a buffer that receives the input.cbDest
[in] Size of the destination buffer, in bytes.For the function to succeed, this value must be greater than sizeof(TCHAR).
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.
Return Value
This function returns an HRESULT, as opposed to gets, which returns a pointer.
It is strongly recommended that you use the SUCCEEDED and FAILED macros to test the return value of this function.
| Value | Description |
|---|---|
| S_OK | Data was read from stdin, was copied to the buffer at pszDest, and the buffer was null-terminated. |
| STRSAFE_E_END_OF_FILE | Indicates an error or end-of-file condition.
To determine which condition has occurred, use feof or ferror. |
| STRSAFE_E_INVALID_PARAMETER | The value in cbDest is larger than the maximum allowed value. |
| STRSAFE_E_INSUFFICIENT_BUFFER | The value in cbDest is sizeof(TCHAR) or less. |
Remarks
StringCbGets provides additional processing for proper buffer handling in your code.
Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCbGets always null-terminates a nonzero-length destination buffer.
StringCbGets can be used in its generic form, or specifically as StringCbGetsA (for ANSI strings) or StringCbGetsW (for Unicode strings). The form to use is determined by your data.
| String data type | String literal | Function |
|---|---|---|
| char | "string" | StringCbGetsA |
| TCHAR | TEXT("string") | StringCbGets |
| WCHAR | L"string" | StringCbGetsW |
StringCbGets and its ANSI and Unicode variants are replacements for these functions:
StringCbGets is not a replacement for fgets. That function does not replace newline characters with a null terminator.
The value of pszDest should not be NULL.
If you need the handling of null string pointer values, see StringCbGetsEx.
Requirements
OS Versions: Windows CE 5.0 and later.
Header: strsafe.h.
Link Library: strsafe.lib.
See Also
StringCchGets | StringCbGetsEx
Send Feedback on this topic to the authors