SafeArrayDestroyData function (oleauto.h)
Destroys all the data in the specified safe array.
Syntax
HRESULT SafeArrayDestroyData(
[in] SAFEARRAY *psa
);
Parameters
[in] psa
A safe array descriptor.
Return value
This function can return one of these values.
| Return code | Description |
|---|---|
|
Success. |
|
The argument psa was not valid. |
|
The array is locked. |
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. Safe arrays of variant will have the VariantClear function called on each member and safe arrays of BSTR will have the SysFreeString function called on each element. IRecordInfo::RecordClear will be called to release object references and other values of a record without deallocating the record.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | oleauto.h |
| Library | OleAut32.lib |
| DLL | OleAut32.dll |