Share via

SafeArrayDestroyDescriptor

  • Article

This function destroys a descriptor of a safearray.

HRESULT SafeArrayDestroyDescriptor(
  SAFEARRAY FAR* psa 
);

Parameters

  • psa
    [in] Pointer to a safearray 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. This function is typically used to destroy the descriptor of a safearray that contains elements with data types other than variants. Destroying the array descriptor does not destroy the elements in the array. Before destroying the array descriptor call SafeArrayDestroyData to free the elements.

Requirements

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

See Also

SafeArrayDestroyData

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.