Skip to content

ArrayTypeOfStruct

Include: Use System\Reflection.pkg

See Also: ArrayTypeOf, ArrayDimensionCount, ArrayDimentionSize, ValueTypeOfArray, ArrayInstanceSize, ValueTypeOfArray

Purpose

Returns struct metadata for arrays whose element type is struct.

Syntax

Function ArrayTypeOfStruct Global Handle hArray Integer iIndex Returns Handle

Arguments

hArray : Array metadata handle.

iIndex : API-compatible element index parameter.

Returns

A struct metadata Handle for the array element type.

Behavior

hArray must describe an array whose value type is C_TypeStruct. Non-struct elements and invalid handles raise a DataFlex error. The runtime accepts iIndex but uses the array's struct metadata; keep the parameter in calls for API compatibility.

Example

Struct tCustomer
    Integer iId
    String sName
End_Struct

tCustomer[] aCustomers
Handle hArray hStruct

Get ArrayTypeOf aCustomers to hArray
Get ArrayTypeOfStruct hArray 0 to hStruct