SafeArrayAllocDescriptor function

Allocates memory for a safe array descriptor.

Syntax


HRESULT SafeArrayAllocDescriptor(
  _In_  UINT      cDims,
  _Out_ SAFEARRAY **ppsaOut
);

Parameters

cDims [in]

The number of dimensions of the array.

ppsaOut [out]

The safe array descriptor.

Return value

This function can return one of these values.

Return codeDescription
S_OK

Success.

E_INVALIDARG

The argument psa was not valid.

E_UNEXPECTED

The array could not be locked.

 

Remarks

This function allows the creation of safe arrays that contain elements with data types other than those provided by SafeArrayCreate. After creating an array descriptor using SafeArrayAllocDescriptor, set the element size in the array descriptor, an call SafeArrayAllocData to allocate memory for the array elements.

Examples

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


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

Requirements

Header

OleAuto.h

Library

OleAut32.lib

DLL

OleAut32.dll

See also

SafeArrayAllocData
SafeArrayDestroyData
SafeArrayDestroyDescriptor

 

 

Show: