Grid library 1.10: Legion implicit parameters

1.10 Legion implicit parameters

The following section contains the functions which allow a program to manipulate its own method and message implicit parameters.

int
MethodImplicitParm_InsertLOID(char *ParmName, char *Loid);

Insert a LOID implicit parameter into the Implicit method parameters

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Loid = The String representation of the LOID to add.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MethodImplicitParm_InsertInt(char *ParmName, int Value);

Insert an int implicit parameter into the Implicit method parameters

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Value = The integer value to be placed into the parameters.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MethodImplicitParm_InsertString(char *ParmName, char *Str);

Insert a new String Implicit Parameter into the implicit method parameter database.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Str = The new string to add to the database.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MethodImplicitParm_Remove(char *ParmName);

Remove an implicit parameter from the implicit method parameters database.

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

char*
MethodImplicitParm_FindLOID(char *ParmName);

Find an implicit parameter in the implicit method parameters database (this parameter must be a LOID parameter).

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
The string representation of the LOID that was found.

Error Return:
NULL

User Responsibility:
The user is responsible for "free"ing the returned LOID when done.

int
MethodImplicitParm_FindInt(char *ParmName);

Find an implicit parameter in the implicit method parameters database (this parm must be an int parameter).

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
The integer parameter that was retrieved from the database.

Error Return:
Need to check LegionErrno for this one.

User Responsibility: None

char*
MethodImplicitParm_FindString(char *ParmName);

Retrieve a string parameter from the implicit method parameter database.

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
The string parameter retrieved from the implicit method
database.

Error Return:
NULL

User Responsibility:
The user is responsible for "free"ing the memory returned
from this function call.

int
MethodImplicitParm_ReplaceLOID(char *ParmName,
char *Loid);

Replace an implicit method parameter in the database with another (LOID) parameter.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Loid = The Loid parameter to replace
      <ParmName> with.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MethodImplicitParm_ReplaceInt(char *ParmName, int Value);

Replace an implicit method parameter in the database with another (Int) parameter.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Value = The value of the integer parameter to
      replace <ParmName> with.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MethodImplicitParm_ReplaceString(char *ParmName,
char *Str);

Replace an implicit method parameter in the database with another (string) parameter.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Str = The string parameter which the user
      wishes to replace <ParmName> with.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MessageImplicitParm_InsertLOID(char *ParmName, char *LOID);

Insert a LOID implicit parameter into the implicit message parameters

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    LOID = the String representation of the LOID to add

Return Values:
0 on Failure
1 on Success

User Responsibility:
None

int
MessageImplicitParm_InsertInt(char *ParmName, int Value);

Insert an int implicit parameter into the implicit message parameters.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Value = The integer value to be placed into the
      parameters.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MessageImplicitParm_InserString(char *ParmName, char *Str);

Insert a new String Implicit Parameter into the implicit message parameter database.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Str = The new string to add to the database.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MessageImplicitParm_Remove(char *ParmName);

Remove an implicit parameter from the implicit message parameters database.

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

char*
MessageImplicitParm_FindLOID(char *ParmName);

Find an implicit parameter in the implicit message parameters database (this parm must be a LOID parameter).

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
The string representation of the LOID that was found.

Error Return:
NULL

User Responsibility:
The user is responsible for "free"ing the returned LOID when
done.

int
MessageImplicitParm_FindInt(char *ParmName);

Find an implicit parameter in the implicit message parameters database (this parm must be an int parameter).

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
The integer parameter that was retrieved from the database.

Error Return:
Need to check LegionErrno for this one.

User Responsibility: None

char*
MessageImplicitParm_FindString(char *ParmName);

Retrieve a string parameter from the implicit message parameter database.

Parameters:
ParmName = The name of the implicit parameter to
which the action is being applied.

Return Values:
The string parameter retrieved from the implicit message
database.

Error Return:
NULL

User Responsibility:
The user is responsible for "free"ing the memory returned
from this function call.

int
MessageImplicitParm_ReplaceLOID(char *ParmName,
char *LOID);

Replace an implicit message parameter in the database with another (LOID) parameter.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    LOID = The LOID parameter to replace <ParmName> with.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MessageImplicitParm_ReplaceInt(char *ParmName, int Value);

Replace an implicit message parameter in the database with another (Int) parameter.

Parameters:

ParmName = The name of the implicit parameter to
      which the action is being applied.
    Value = The value of the integer parameter to
      replace <ParmName> with.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

int
MessageImplicitParm_ReplaceString(char *ParmName,
char *Str);

Replace an implicit message parameter in the database with another (string) parameter.

Parameters:
    ParmName = The name of the implicit parameter to
      which the action is being applied.
    Str = The string parameter which the user
      wishes to replace <ParmName> with.

Return Values:
0 on Failure
1 on Success

User Responsibility: None

Back to grid library table of contents
Next section