Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

Syntax

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

Parameters

pch

[in] Pointer to cchcharacters to copy, or NULL to keep the string uninitialized.

cch

[in] Number of characters to copy from pch.

A null character is placed afterwards, allocating a total of cch+1 characters.

Return Value

A pointer to a copy of the string indicates success.

NULL indicates that insufficient memory exists.

Remarks

If pchis NULL, a string of the requested length is allocated, but not initialized.

The pchstring can contain embedded null characters and does not need to end with a NULL.

Free the returned string later with SysFreeString.

Windows Embedded CE and Windows Mobile only support Unicode strings.

Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.

Requirements

Header oleauto.h
Library oleaut32.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also