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.
STRSAFEAPI StringCchGetsW( STRSAFE_LPWSTR pszDest, size_t cchDest );
The destination buffer, which receives the copied characters.
The 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.
||Characters were read from stdin, were copied to the buffer at pszDest, and the buffer was null-terminated.|
||Indicates an error or end-of-file condition. Use feof or ferror to determine which one has occurred.|
||The value in cchDest is larger than the maximum allowed value.|
||The value in cchDest is 1 or less.|
Note that this function returns an HRESULT value, unlike the functions that it replaces.
StringCchGets provides additional processing for proper buffer handling in your code. Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCchGetsalways null-terminates a nonzero-length destination buffer.
The value of pszDest should not be NULL. See StringCchGetsEx if you require the handling of null string pointer values.
StringCchGets 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 | UWP apps]|
|Minimum supported server||Windows Server 2003 with SP1 [desktop apps | UWP apps]|