Share via

SafeArrayDestroyData

  • Article

This function destroys all the data in a safearray.

HRESULT SafeArrayDestroyData( 
  SAFEARRAY FAR* psa 
);

Parameters

  • psa
    [in] Pointer to an array descriptor.

Return Values

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

Value Description
S_OK Success.
DISP_E_ARRAYISLOCKED The array is currently locked.
E_INVALIDARG The item pointed to by psa is not a safearray descriptor.

Remarks

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

Remarks

This function is typically used when freeing safe arrays that contain elements with data types other than variants. If objects are stored in the array, Release is called on each object in the array.

Requirements

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

See Also

SafeArrayAllocData | SafeArrayAllocDescriptor | SafeArrayDestroyDescriptor

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.