All Frameworks Class Hierarchy This Framework Indexes

System Global Function ConvertSafeArrayVariant

ConvertSafeArrayVariant(	const	`iSafeArray`,
		`ioObjectArray`,
		`iSize`	`= 0`)

Converts a CATSafeArrayVariant into a C++ array of CATBaseDispatch. interfaces.

Parameters:

iSafeArray

the array to convert

ioObjectArray

a pointer to a C++ array of CATBaseDispatch interfaces large enough to contain all the converted values.
Legal values:

NULL: The function will simply return the size of the CATSafeArrayVariant without converting anything. This size can later be used to allocate the C++ array to the proper size.
valid non NULL pointer: The function will convert the CATSafeArrayVariant and put the results in the array.

Lifecycle rules deviation:the reference count of the CATBaseDispatch objects returned in the C++ array is not altered, so there is no need to call Release on these objects after the ConvertSafeArrayVariant call.

iSize

the number of elements to convert.
Legal values:Must be smaller than or equal to the size of iSafeArray.

Returns:

the number of converted elements if ioObjectArray is not NULL, or the size of iSafeArray otherwise.

This object is included in the file: CATAutoConversions.h