Skip to content

StructMemberName

Include: Use System\Reflection.pkg

See Also: StructTypeOf, StructMemberCount, StructMemberType, StructMemberName, StructMember, StructSetMember

Purpose

Returns the public member name for a struct member by zero-based index.

Syntax

Function StructMemberName Global Handle hStruct Integer iIndex Returns String

Arguments

hStruct : Struct metadata handle.

iIndex : Zero-based member index.

Returns

The public member name.

Behavior

When a member has { Name="..." } metadata, StructMemberName returns the metadata name. Otherwise it returns the declared member name. Out-of-range indexes and invalid handles raise a DataFlex error.

Example

Struct tCustomer
    Integer iId
    { Name="name" }
    String sName
End_Struct

tCustomer tCustomerValue
Handle hStruct

Move 1 to tCustomerValue.iId
Move "Ada" to tCustomerValue.sName
Get StructTypeOf tCustomerValue to hStruct

String sName
Get StructMemberName hStruct 1 to sName
// sName is "name"