SafeArrayAllocData

This function allocates memory for a safe array, based on a descriptor created with SafeArrayAllocDescriptor.

At a Glance

Header file:	Oleauto.h
Windows CE versions:	2.0 and later

Syntax

HRESULT SafeArrayAllocData(SAFEARRAY FAR * psa);

Parameters

psa

Pointer to an array descriptor created by SafeArrayAllocDescriptor.

Return Values

One of the values obtained from the returned HRESULT and described in the following table is returned.

Value	Description
S_OK	Success.
E_INVALIDARG	The psa parameter was not a valid safe array descriptor.
E_UNEXPECTED	The array could not be locked.

Remarks

Passing into this function any invalid and, under some circumstances, NULL pointers will result in unexpected termination of the application.

Example

The following code example creates a safe array using the SafeArrayAllocDescriptor and SafeArrayAllocData functions.

SAFEARRAY FAR* FAR*ppsa;
unsigned int ndim = 2;
HRESULT HRESULT = SafeArrayAllocDescriptor(ndim, ppsa);
if( FAILED(hresult))
   return ERR_OutOfMemory;
(*ppsa)->rgsabound[ 0 ].lLbound = 0;
(*ppsa)->rgsabound[ 0 ].cElements = 5;
(*ppsa)->rgsabound[ 1 ].lLbound = 1;
(*ppsa)->rgsabound[ 1 ].cElements = 4;
HRESULT = SafeArrayAllocData(*ppsa);
if( FAILED(hresult)) {
   SafeArrayDestroyDescriptor(*ppsa)
   return ERR_OutOfMemory;
}