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

  BAR::Get_Function_Parameter_Type
BAR::Get_Function_Parameter_Name

Purpose: To retrieve parameter type and parameter name of a specific function parameter.

Value_Info Get_Function_Parameter_Type(Function_Identifier Function_ID, long Parameter_Position);
BAR_String Get_Function_Parameter_Name(Function_Identifier Function_ID, long Parameter_Position);


Parameters

  • Function_Identifier Function_ID: A function identifier (generally name or UID).
  • long Parameter_Position: A zero-based parameter position.

Return Values

  • Get_Function_Parameter_Type
    • Normal: Results for parameter value type.
    • Invalid_Value_Info: Error.
  • Get_Function_Parameter_Name
    • Non-null: Parameter name.
    • Null: Error.

Remarks

Get_Function_Parameter_Type retrieves information on the type associated with the specified parameter. Get_Function_Parameter_Name retrieves the name of a function parameter.

The Parameter_Position is the zero-based position of the parameter to look up. For example, a value of 3 will look up the 4th parameter.

The functions will fail if Function_ID is not a valid identifier for a function, or if Parameter_Position is outside of the possible range of values for positions (less than zero, or greater than or equal to the return value of Get_Function_Parameter_Count).

For Get_Function_Parameter_Type, the information is placed in a Value_Info type.  The return type Invalid_Value_Info is returned in the event of failure.

Function_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