SafeArrayCopy function (oleauto.h)

Article
10/13/2021

Creates a copy of an existing safe array.

Syntax

HRESULT SafeArrayCopy(
  [in]  SAFEARRAY *psa,
  [out] SAFEARRAY **ppsaOut
);

Parameters

[in] psa

A safe array descriptor created by SafeArrayCreate.

[out] ppsaOut

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

Requirement	Value
Target Platform	Windows
Header	oleauto.h
Library	OleAut32.lib
DLL	OleAut32.dll