Edit

Share via

StrCatChainW function (shlwapi.h)

  • Article

Concatenates two Unicode strings. Used when repeated concatenations to the same buffer are required.

Syntax

DWORD StrCatChainW(
  [out] PWSTR  pszDst,
        DWORD  cchDst,
        DWORD  ichAt,
  [in]  PCWSTR pszSrc
);

Parameters

[out] pszDst

Type: PWSTR

A pointer to a buffer that, when this function returns successfully, receives the null-terminated, Unicode string.

cchDst

Type: DWORD

The size of the destination buffer, in characters. This buffer must be of sufficient size to hold both strings as well as a terminating null character. If the buffer is too small, the final string is truncated.

ichAt

Type: DWORD

The offset into the destination buffer at which to begin the append action. If the string is not empty, set this value to -1 to have the current number of filled characters (not including the terminating null character) calculated for you.

[in] pszSrc

Type: PCWSTR

A pointer to the null-terminated Unicode source string.

Return value

Type: DWORD

Returns the offset of the null character after the last character added to pszDst.

Remarks

Security Warning:  Using this function incorrectly can compromise the security of your application. The final string is not guaranteed to be null-terminated. Consider using one of the following alternatives: StringCbCatEx, StringCbCatNEx, StringCchCatEx, or StringCchCatNEx. You should review Security Considerations: Microsoft Windows Shell before continuing.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (version 5.5 or later)