SafeArrayCopy

  • Article

This function creates a copy of an existing safearray.

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

Parameters

  • psa
    [in] Pointer to an array descriptor created by SafeArrayCreate.
  • ppsaOut
    [out] Pointer to a location in which to return the new array descriptor.

Return Values

The following table shows the HRESULT values that can be returned by this function.

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

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. Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oleauto.h.
Link Library: Oleaut32.lib.

See Also

SysAllocStringLen | VariantCopy | VariantCopyInd | SafeArrayCreate

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.