This function destroys a decriptor of a safe array.
At a Glance
Header file: | Oleauto.h |
Windows CE versions: | 2.0 and later |
Syntax
HRESULT SafeArrayDestroyDescriptor(SAFEARRAY FAR * psa);
Parameters
psa
Pointer to a safe array descriptor.
Return Values
One of the values obtained from the returned HRESULT and described in the following table is returned.
Value | Description |
S_OK | Success. |
DISP_E_ARRAYISLOCKED | The array is currently locked. |
E_INVALIDARG | The item pointed to by psa is not a safe array descriptor. |
Remarks
Passing into this function any invalid and, under some circumstances, NULL pointers will result in unexpected termination of the application.
Remarks
This function is typically used to destroy the descriptor of a safe array 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.