StringCchCopyEx (Windows Embedded CE 6.0)

1/5/2010

This function is a replacement for strcpy.

The size, in characters, of the destination buffer is provided to the function to ensure that StringCchCopyEx does not write past the end of this buffer.

StringCchCopyEx adds to the functionality of StringCchCopy by returning a pointer to the end of the destination string, and by returning the number of characters left unused in that string.

Flags can also be passed to the function for additional control.

Syntax

HRESULT StringCchCopyEx(      
    LPTSTR pszDest,
    size_t cchDest,
    LPCTSTR pszSrc,
    LPTSTR *ppszDestEnd,
    size_t *pcchRemaining,
    DWORD dwFlags
);

Parameters

• pszDest
  [out] Pointer to a buffer that receives the copied string.

• cchDest
  [in] Size of the destination buffer, in characters.

  This value must equal the length of pszSrc plus 1 to account for the copied source string and the terminating null character.

  The maximum number of characters allowed is STRSAFE_MAX_CCH.

• pszSrc
  [in] Pointer to a buffer containing the source string.

  This source string must be null-terminated.

• ppszDestEnd
  [out] Address of a pointer to the end of pszDest.

  If ppszDestEnd is non-NULL and data is copied into the destination buffer, this points to the terminating null character at the end of the string.

• pcchRemaining
  [out] Pointer to a variable that indicates the number of unused characters in pszDest, including the terminating null character.

  If pcchRemaining is NULL, the count is not kept or returned.

• dwFlags
  [in] One or more of the following values.

  Value	Description
  STRSAFE_FILL_BEHIND_NULL	If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character.
  STRSAFE_IGNORE_NULLS	Treat null string pointers like empty strings (TEXT("")). This flag is useful for emulating functions such as lstrcpy.
  STRSAFE_FILL_ON_FAILURE	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.
  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.
  STRSAFE_NO_TRUNCATION	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.

Return Value

This function returns an HRESULT, as opposed to strcpy, which returns a pointer.

It is strongly recommended that you use the SUCCEEDED and FAILED macros to test the return value of this function.

Remarks

StringCchCopyEx provides additional processing for proper buffer handling in your code.

Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCchCopyEx always null-terminates a nonzero-length destination buffer.

StringCchCopyEx can be used in its generic form, or specifically as StringCchCopyExA (for ANSI strings) or StringCchCopyExW (for Unicode strings). The form to use is determined by your data.

If the strings pointed to by pszSrc and pszDest overlap, behavior is undefined.

Neither pszSrc nor pszDest should be NULL unless the STRSAFE_IGNORE_NULLS flag is specified; in which case both might be NULL.

An error due to insufficient space might still be returned even though null values are ignored.

Requirements

See Also

Reference

StrSafe.h Character-Count Functions
StringCchCopy
StringCbCopyEx