The RtlStringCchCopyNExW and RtlStringCchCopyNExA functions copy a character-counted string to a buffer while limiting the size of the copied string.
NTSTATUS RtlStringCchCopyNExW( _Out_opt_ LPTSTR pszDest, _In_ size_t cchDest , _In_opt_ LPCTSTR pszSrc, _In_ size_t cchSrc, _Out_opt_ LPTSTR *ppszDestEnd, _Out_opt_ size_t *pcchRemaining, _In_ DWORD dwFlags );
A pointer to a caller-supplied buffer that receives the copied string. The string at pszSrc is copied to the buffer at pszDest and terminated with a null character. The pszDest pointer can be NULL, but only if STRSAFE_IGNORE_NULLS is set in dwFlags.
The size, in characters, of the destination buffer. The maximum number of characters allowed is NTSTRSAFE_MAX_CCH. If pszDest is NULL, cchDest must be zero.
A pointer to a caller-supplied, null-terminated string.
If the caller supplies a non-NULL address pointer then, after the copy operation completes, the function loads that address with a pointer to the destination buffer's resulting null string terminator.
If the caller supplies a non-NULL address pointer, the function loads the address with the number of unused characters that are in the buffer pointed to by pszDest, including the terminating null character.
One or more flags and, optionally, a fill byte. The flags are defined as follows:
The function returns one of the NTSTATUS values that are listed in the following table. For information about how to test NTSTATUS values, see Using NTSTATUS Values.
||This success status means source data was present, the string was copied without truncation, and the resultant destination buffer is null-terminated.|
||This warning status means the copy operation did not complete due to insufficient space in the destination buffer. If STRSAFE_NO_TRUNCATION is set in dwFlags, the destination buffer is not modified. If the flag is not set, the destination buffer contains a truncated version of the created string.|
This error status means the function received an invalid input parameter. For more information, see the following paragraph.
The function returns the STATUS_INVALID_PARAMETER value when:
RtlStringCchCopyNExW and RtlStringCchCopyNExA should be used instead of strncpy.
The functions copy a given number of characters from a source string. The size, in characters, of the destination buffer is provided to RtlStringCchCopyNExW and RtlStringCchCopyNExA to ensure that they do not write past the end of the buffer.
Note that these functions behave differently from strncpy in one respect. If cchSrc is larger than the number of characters in pszSrc, RtlStringCchCopyNExW and RtlStringCchCopyNExA—unlike strncpy—do not continue to pad pszDest with null characters until cchSrc characters have been copied.
RtlStringCchCopyNExW and RtlStringCchCopyNExA add to the functionality of RtlStringCchCopyN by returning a pointer to the end of the destination string, as well as the number of characters left unused in that string. Flags can be passed to the function for additional control.
Use RtlStringCchCopyNExW to handle Unicode strings and RtlStringCchCopyNExA to handle ANSI strings. The form you use depends on your data, as shown in the following table.
|String data type||String literal||Function|
If pszSrc and pszDest point to overlapping strings, the behavior of the function is undefined.
Neither pszSrc nor pszDest can be NULL unless the STRSAFE_IGNORE_NULLS flag is set, in which case either or both can be NULL. If pszDest is NULL, pszSrc must either be NULL or point to an empty string.
For more information about the safe string functions, see Using Safe String Functions.
|Windows version||Available in Windows XP with Service Pack 1 (SP1) and later versions of Windows.|
|Header||ntstrsafe.h (include Ntstrsafe.h)|