messiah_variable.h


Provides Variable related information and manipulation.

Version:
1.1
Date:
6/07/03
Topics


Functions

FXvariable fxVarCreate (FXchar *name, FXvariable parent, FXint flags)
 Create a new Variable.

FXint fxVarDelete (FXvariable var, FXint flags)
 Delete a Variable.

FXint fxVarName (FXvariable var, FXchar *buffer, FXint buffer_length, FXint flags)
 Get the name of a variable.

FXint fxVarRename (FXvariable var, FXchar *name, FXint flags)
 Set the name of a Variable.

FXint fxVarExp (FXvariable var, FXchar *buffer, FXint buffer_length, FXint flags)
 Get the expression of a variable.

FXint fxVarExpSet (FXvariable var, FXchar *exp, FXint flags)
 Set the expression of a Variable.

FXint fxVarExpLength (FXvariable var)
 Get the length of a Variable's expression string.

FXint fxVarChannelAdd (FXvariable var, FXobject obj, FXint channel, FXint op, FXint *ID, FXint flags)
 Add a channel to a Variable.

FXint fxVarChannelRemove (FXvariable var, FXint ID, FXint flags)
 Remove a channel from a Variable.


Function Documentation

FXint fxVarChannelAdd FXvariable    var,
FXobject    obj,
FXint    channel,
FXint    op,
FXint   ID,
FXint    flags
 

Add a channel to a Variable.

Parameters:
var [in] Variable to add channel to
obj [in] Object the channel belongs to
channel [in] Channel Identifier Macro
op [in] Channel Operator Macro
ID [out] Storage for the index of the channel once added to the Variable
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
Attaching a channel to a Variable caused the channel to take on the value of the Variable. You can elect to blend the value of the Variable with the existing value of the channel by selecting different Channel Operator Macros for the op parameter.

FXint fxVarChannelRemove FXvariable    var,
FXint    ID,
FXint    flags
 

Remove a channel from a Variable.

Parameters:
var [in] Variable to remove channel from
ID [in] Index of the channel to remove
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
This will remove the channel at (0 based) index ID.

FXvariable fxVarCreate FXchar   name,
FXvariable    parent,
FXint    flags
 

Create a new Variable.

Parameters:
name [in] Name of the new Variable
parent [in] FXvariable ID of parent Variable (or FX_NULLID for none)
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
This function creates a new Variable in messiah's Command Mode. Variables can be parented to other variables for organization. If you specify a parent then the new Variable will become the last child of that parent. If you don't specify a parent (i.e. pass FX_NULLID) then the Variable will be inserted after the currently selected Variable. {VERIFY}

FXint fxVarDelete FXvariable    var,
FXint    flags
 

Delete a Variable.

Parameters:
var [in] Variable to delete
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxVarExp FXvariable    var,
FXchar   buffer,
FXint    buffer_length,
FXint    flags
 

Get the expression of a variable.

Parameters:
var [in] Variable to get expression from
buffer [out] Storage for the expression string Variable
buffer_length [in] Length of the buffer
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxVarExpLength FXvariable    var
 

Get the length of a Variable's expression string.

Parameters:
var [in] The Variable
Returns:
The length of the expression string

FXint fxVarExpSet FXvariable    var,
FXchar   exp,
FXint    flags
 

Set the expression of a Variable.

Parameters:
var [in] Variable to set expression on
exp [in] New expression string
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxVarName FXvariable    var,
FXchar   buffer,
FXint    buffer_length,
FXint    flags
 

Get the name of a variable.

Parameters:
var [in] Variable to get name from
buffer [out] Storage for the name of the Variable
buffer_length [in] Length of the buffer
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxVarRename FXvariable    var,
FXchar   name,
FXint    flags
 

Set the name of a Variable.

Parameters:
var [in] Variable to rename
name [in] New name
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

Last Updated on Thu Jul 10 04:49:37 2003