SafeArrayAllocData (Compact 2013)

Article
11/04/2015

3/26/2014

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

Syntax

HRESULT SafeArrayAllocData(
  SAFEARRAY FAR* psa 
);

Parameters

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

Return Value

Returns the HRESULT values shown in the following table.

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

Remarks

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

Example

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

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

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;
}

Requirements

Header	oleauto.h
Library	oleaut32.lib

Partager via