SafeArrayDestroy

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function destroys an array descriptor and all data in the array.

If objects are stored in the array, Release is called on each object in the array.

Syntax

HRESULT SafeArrayDestroy( 
  SAFEARRAY FAR* psa 
); 

Parameters

• psa
  [in] Pointer to an array descriptor created by SafeArrayCreate.

Return Value

Returns the HRESULT values shown in the following table.

Remarks

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

Example

STDMETHODIMP_(ULONG) CEnumPoint::Release()
{
  if(--m_refs == 0){
    if(m_psa != NULL)
    SafeArrayDestroy(m_psa);
    delete this;
    return 0;
  }
  return m_refs;
}

Requirements

See Also

Reference

Automation Functions
SafeArrayCreate