SysAllocStringLen

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function allocates a new string, copies cch characters 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 cch characters 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 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 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

See Also

Reference

Automation Functions
SysFreeString