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

  BAR::Get_Construct_Min_Size
BAR::Get_Construct_Min_Bit_Size

Purpose: To retrieve the minimum byte size or minimum bit size of a construct.

long Get_Construct_Min_Size(Construct_Identifier Construct_ID);
long Get_Construct_Min_Bit_Size(Construct_Identifier Construct_ID);


Parameters

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

Return Values

  • Nonnegative: Minimum byte or bit size of construct.
  • Negative: Error code.

Remarks

Get_Construct_Min_Size retrieves the byte size of the construct identified by Construct_ID.  Get_Construct_Min_Bit_Size retrieves the bit size of the construct identified by Construct_ID.

If the construct by design does not have a minimum size (list), the constant Variable_Size is returned.

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