SafeArrayDestroyData

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function destroys all the data in a safearray.

Syntax

HRESULT SafeArrayDestroyData( 
  SAFEARRAY FAR* psa 
); 

Parameters

  • psa
    [in] Pointer to an array descriptor.

Return Value

Returns the HRESULT values shown in the following table.

Value Description

S_OK

Success.

DISP_E_ARRAYISLOCKED

The array is 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

Typically, this function is 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

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

See Also

Reference

Automation Functions
SafeArrayAllocData
SafeArrayAllocDescriptor
SafeArrayDestroyDescriptor