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

  BAR::Get_Construct_Attribute

Purpose: To retrieve info on presence or absence of a construct attribute.

bool Get_Construct_Attribute(Construct_Identifier Construct_ID, BAR_String Attribute_Name);


Parameters

  • Construct_Identifier Construct_ID: A construct identifier (generally name or UID).
  • BAR_String Attribute_Name: An attribute name.

Return Values

  • True: Attribute present.
  • False: Attribute absent or error.

Remarks

This function retrieves information on the presence or absence of an attribute of the construct identified by Construct_ID.  The function returns true if the attribute, specified by Attribute_Name, is present for the construct. If it is absent, a false value is returned.

The following strings for Attribute_Name are supported:

  • signed
  • unsigned
  • bigendian
  • littleendian
  • organized
  • unorganized
  • textual
  • bitscan
  • bitfield
  • repeats
  • optional
  • discardable
  • nofragment
  • autoterminate

The function will fail (return false) if Construct_ID is not a valid identifier for a construct, if the attribute name is unsupported, or if the construct does not support the particular attribute requested.

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