SysAllocStringLen

This function allocates a new string, copies cch characters from the passed string into it, and then appends a null character.

At a Glance

Header file: Oleauto.h
Windows CE versions: 2.0 and later

Syntax

BSTR SysAllocStringLen(OLECHAR FAR * pch, unsigned int cch);

Parameters

pch

Pointer to cch characters to copy, or NULL to keep the string uninitialized.

cch

Number of characters to copy from pch. A null character is placed afterwards, allocating a total of cch+1 characters.

Return Values

A pointer to a copy of the string indicates success. NULL indicates that insufficient memory exists.

Remarks

If pch is NULL, a string of the requested length is allocated, but not initialized. The pch string can contain embedded null characters and does not need to end with a NULL. Free the returned string later with SysFreeString.

Windows CE supports only Unicode strings.

Passing into this function any invalid and, under some circumstances, NULL pointers will result in unexpected termination of the application.