This topic has not yet been rated - Rate this topic

SafeArrayCopy function

Applies to: desktop apps | Metro style apps

Creates a copy of an existing safe array.

Syntax

Copy

HRESULT SafeArrayCopy(
  __in   SAFEARRAY *psa,
  __out  SAFEARRAY **ppsaOut
);

Parameters

psa [in]: A safe array descriptor created by SafeArrayCreate.
ppsaOut [out]: The safe array descriptor.

Return value

This function can return one of these values.

Return code	Description
S_OK	Success.
E_INVALIDARG	The argument psa was not valid.
E_OUTOFMEMORY	Insufficient memory to complete the operation.

Remarks

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.

Requirements