BARfly Help - BAR Interfacial Function Reference - BAR type lookup functions

  BAR::Get_Construct_Type

Purpose: To retrieve a construct type.

Node_Type_Constant Get_Construct_Type(Construct_Identifier Construct_ID);


Parameters

Construct_Identifier Construct_ID: A construct identifier (generally name or UID).

Return Values

  • Nonnegative: One of the following:
    • BAR_SIMPLE_TYPE: Simple Type.
    • BAR_SIMPLE_STRUCT: Simple Structure.
    • BAR_BITFIELD_STRUCT: Bit Field Structure.
    • BAR_COMPLEX_STRUCT: Complex Structure.
    • BAR_ARRAY_OF_SIMPLE: Array of Simple Types.
    • BAR_ARRAY_OF_COMPLEX: Array of Complex Types.
    • BAR_NODE_LIST: Node List.
    • BAR_DECISION_LIST: Decision List.
    • BAR_ORGANIZED_BLOCK: Organized Block.
    • BAR_UNORGANIZED_BLOCK: Unorganized Block.
  • Negative: Error code.

Remarks

This function retrieves the specific type of construct to which the construct identified by Construct_ID belongs.

Construct_ID is a platform-dependent identifier.

The function will fail if Construct_ID is not a valid identifier for a construct.

Compatibility

  All Platforms Win32 C++ LIB
BAR version 1.1 1.1
  All Platforms Win32
BARfly version 1.0 1.0


  See also:  [BAR type lookup functions] [BAR loading and saving functions] [BAR node navigation functions]
[BAR node information functions] [BAR data reading functions] [BAR data writing functions] [BAR miscellaneous functions]


BARfly Help Copyright © 2009 Christopher Allen