GetArrayInfo

Description

Obtains information about an array.

Syntax

GetArrayInfo(pbarray array)

1	GetArrayInfo(pbarray array)

Argument	Description
array	A valid array handle

Return value

PBArrayInfo*.

Examples

This IF-ELSE statement populates a PBArrayInfo structure if the
array in the first value of a PBCallInfo structure is not null:

if ( !(ci-&gt;pArgs-&gt;GetAt(0)-&gt;IsNull()) )
{
   array = ci-&gt;pArgs-&gt;GetAt(0)-&gt;GetArray();
   pArrayInfo = session-&gt;GetArrayInfo (array);
   pArrayItemCount = session-&gt;GetArrayLength(array);
}
else
{
   // NULL array
pArrayItemCount = 0;
}

if ( !(ci->pArgs->GetAt(0)->IsNull()) )

{

array = ci->pArgs->GetAt(0)->GetArray();

pArrayInfo = session->GetArrayInfo (array);

pArrayItemCount = session->GetArrayLength(array);

}

else

{

// NULL array

pArrayItemCount = 0;

}

Usage

If the array is an unbounded array, the bounds information in
PBArrayInfo is undetermined. The returned PBArrayInfo must be freed
later by ReleaseArrayInfo.

See also

NewBoundedObjectArray

NewBoundedSimpleArray

NewUnboundedObjectArray

NewUnboundedSimpleArray

ReleaseArrayInfo

SetArrayItemToNull

SetArrayItemValue