Windows Safe String Function

HRESULT StringCbGets(LPTSTR pszDest, size_t cbDest);

HRESULT StringCbGetsA(LPSTR pszDest, size_t cbDest);

HRESULT StringCbGetsW(LPWSTR pszDest, size_t cbDest);

HRESULT StringCbGetsEx(LPTSTR pszDest, size_t cbDest, LPTSTR *ppszDestEnd, size_t *pcbRemaining, DWORD dwFlags);

HRESULT StringCbGetsExA(LPSTR pszDest, size_t cbDest, LPSTR *ppszDestEnd, size_t *pcbRemaining, DWORD dwFlags);

HRESULT StringCbGetsExW(LPWSTR pszDest, size_t cbDest, LPWSTR *ppszDestEnd, size_t *pcbRemaining, DWORD dwFlags);

Internationalization (I18n) Function Overview

The StringCbGets function is a replacement for locale-sensitive input functions. It retrieves one line of text from stdin, with a newline ('\n') ending the input, and stores it in pszDest, replacing the newline with a terminating null character. The byte size of the buffer, stored in cbDest, is used to ensure that the destination string buffer is not overrun. In the event of an error, a negative HRESULT value is returned, indicating the error.

StringCbGetsEx adds advanced functionality: It returns a pointer to the end of the destination string as well as the number of bytes left unused in that string, and uses dwFlags for additional control.

The narrow versions of these functions, StringCbGetsA and StringCbGetsExA, pass in single-byte or multibyte strings and lengths that refer to the number of bytes.

The wide versions of these functions, StringCbGetsW and StringCbGetsExW, pass in wide-character strings, but, like the narrow versions, lengths that refer to the number of bytes.

I18n Issues

Use the appropriate version of the function as required for internationalization support, and ensure that cbDest is set to the byte size of the destination string buffer. See Locale-Sensitive Length Functions for a discussion on multibyte and wide character sizes.

Recommended Replacements*

When possible, use the Generic version of the function, rather than the narrow or wide versions, and let the Windows #define UNICODE switch determine which version of the function will be called. These are shown as the first choices in the following table:

Microsoft Windows MBCS	StringCbGets/StringCbGetsEx or StringCbGetsA/StringCbGetsExA
Microsoft Windows Unicode	StringCbGets/StringCbGetsEx or StringCbGetsW/StringCbGetsExW
Microsoft Windows Generic	StringCbGets/StringCbGetsEx

Windows Safe String Functions