SafeArrayCopy

A version of this page is also available for

4/8/2010

This function creates a copy of an existing safearray.

Syntax

HRESULT SafeArrayCopy(
  SAFEARRAY FAR* psa, 
  SAFEARRAY FAR* FAR* ppsaOut 
);

ppsaOut
[out] Pointer to a location in which to return the new array descriptor.

Returns the HRESULT values shown in the following table.

Value	Description
S_OK	Success.
E_INVALIDARG	The psa parameter was not a valid safearray descriptor.
E_OUTOFMEMORY	Insufficient memory to create the copy.

SafeArrayCopy calls the string or variant manipulation functions if the array to copy contains either of these data types.

If the array being copied contains object references, the reference counts for the objects are incremented.

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

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