StringCchGets (Windows Embedded CE 6.0)
1/5/2010
This function is a replacement for gets.
The size, in characters, of the destination buffer is provided to the function to ensure that StringCchGets 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.
Syntax
HRESULT StringCchGets(
LPTSTR pszDest,
size_t cchDest
);
Parameters
- pszDest
[out] Pointer to a buffer that receives the copied characters.
cchDest
[in] Size of the destination buffer, in characters.This value must be at least 2 for the function to succeed.
The maximum number of characters allowed, including the terminating null character, is STRSAFE_MAX_CCH.
If cchDest 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 |
Characters were read from stdin, were 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 occurred, use feof or ferror. |
STRSAFE_E_INVALID_PARAMETER |
The value in cchDest is larger than the maximum allowed value. |
STRSAFE_E_INSUFFICIENT_BUFFER |
The value in cchDest is 1 or less. |
Remarks
StringCchGets provides additional processing for proper buffer handling in your code.
Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCchGets always null-terminates a nonzero-length destination buffer.
StringCchGets can be used in its generic form, or specifically as StringCchGetsA (for ANSI strings) or StringCchGetsW (for Unicode strings). The form to use is determined by your data.
| String data type | String literal | Function |
|---|---|---|
char |
"string" |
StringCchGetsA |
TCHAR |
TEXT("string") |
StringCchGets |
WCHAR |
L"string" |
StringCchGetsW |
StringCchGets 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 StringCchGetsEx.
Requirements
| Header | strsafe.h |
| Windows Embedded CE | Windows CE 5.0 and later |
See Also
Reference
StrSafe.h Character-Count Functions
StringCbGets
StringCchGetsEx