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

  BAR::Get_Construct_UID

Purpose: To retrieve a unique identifier (UID) for a construct.

long Get_Construct_UID(Construct_Identifier Construct_ID);


Parameters

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

Return Values

  • Nonnegative: Construct UID.
  • Negative: Error code.

Remarks

This function retrieves a unique identifier (UID) for the construct identified by Construct_ID.

A unique identifier is a zero-based number that identifies most constructs, and is a valid quantity for the platform-dependent type Construct_Identifier. A construct UID for a particular construct will vary from one implementation file to another, and even from one compilation of the same implementation file to the next.

The following UIDs are defined for every implementation file.

  • BAR_CHAR_TYPE: This identifies the “char” Simple Type.
  • BAR_SHORT_TYPE: This identifies the “short” Simple Type.
  • BAR_LONG_TYPE: This identifies the “long” Simple Type.
  • BAR_LONGLONG_TYPE: This identifies the “longlong” Simple Type.
  • BAR_FLOAT_TYPE: This identifies the “float” Simple Type.
  • BAR_DOUBLE_TYPE: This identifies the “double” Simple Type.

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

Construct_ID is a platform-dependent identifier.

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