Argument Lists

Functions
ArgList_pa	TecUtilArgListAlloc (void)
	Allocate an argument list.
void	TecUtilArgListClear (ArgList_pa ArgList)
	Clear all arguments from an argument list.
Boolean_t	TecUtilArgListAppendInt (ArgList_pa ArgList, const char *Name, LgIndex_t Value)
	Append an integer parameter to an argument list.
Boolean_t	TecUtilArgListAppendArbParam (ArgList_pa ArgList, const char *Name, ArbParam_t Value)
	Append an ArbParam_t type parameter to an argument list
Boolean_t	TecUtilArgListAppendArbParamPtr (ArgList_pa ArgList, const char *Name, ArbParam_t *Value)
	Appends an ArbParam_t pointer parameter to an argument list.
Boolean_t	TecUtilArgListAppendDouble (ArgList_pa ArgList, const char *Name, double Value)
	Append a double parameter to an argument list.
Boolean_t	TecUtilArgListAppendDoublePtr (ArgList_pa ArgList, const char *Name, double *Value)
	Appends a double pointer parameter to an argument list.
Boolean_t	TecUtilArgListAppendString (ArgList_pa ArgList, const char *Name, const char *Value)
	Append a string to an argument list.
Boolean_t	TecUtilArgListAppendArray (ArgList_pa ArgList, const char *Name, const void *Value)
	Appends a named array reference to the argument list.
Boolean_t	TecUtilArgListAppendSet (ArgList_pa ArgList, const char *Name, Set_pa Value)
	Append a named set reference to an argument list.
Boolean_t	TecUtilArgListAppendStringList (ArgList_pa ArgList, const char *Name, StringList_pa StringList)
	Append a named string list reference to an argument list.
Boolean_t	TecUtilArgListAppendFunction (ArgList_pa ArgList, const char *Name, const void *Value)
	Append a named function pointer to an argument list.
void	TecUtilArgListDealloc (ArgList_pa *ArgList)
	Deallocate an argument list.

---

Function Documentation

ArgList_pa TecUtilArgListAlloc

(

void

)

Allocate an argument list.

Argument lists are used with all of the "X" (extended) functions in Tecplot.

Returns:

Returns an ArgList object if successful, otherwise NULL.

Fortran Syntax:

    SUBROUTINE TecUtilArgListAlloc(ResultPtr)
    POINTER (ResultPtr, Result)

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendArbParam	(	ArgList_pa	ArgList,
		const char *	Name,
		ArbParam_t	Value
	)

Append an ArbParam_t type parameter to an argument list

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	Value associated with the parameter name.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendArbParam(
   &                   ArgListPtr,
   &                   Name,
   &                   ValuePtr)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    POINTER         (ValuePtr, Value)

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendArbParamPtr	(	ArgList_pa	ArgList,
		const char *	Name,
		ArbParam_t *	Value
	)

Appends an ArbParam_t pointer parameter to an argument list.

Parameters:

	ArgList	The argument list
	Name	Parameter Name. Use the SV_ constants listed with the extended function.
	Value	Pointer value associated with the parameter name

Returns:

Returns TRUE is append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Value Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendArbParamPtr(
   &                   ArgListPtr,
   &                   Name,
   &                   ValuePtr)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    POINTER         (ValuePtr, Value)

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendArray	(	ArgList_pa	ArgList,
		const char *	Name,
		const void *	Value
	)

Appends a named array reference to the argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	Array reference associated with the parameter name. Tecplot does not make a copy of the array so the client must maintain the array until the ArgList is cleared or deallocated at which point the array can be deallocated.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Value Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendArray(
   &                   ArgListPtr,
   &                   Name,
   &                   Value)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    POINTER         (ValuePtr, Value)

Python Syntax:

    This function is not supported in Python.

Referenced by tecplot::toolbox::ArgList::appendArray().

Boolean_t TecUtilArgListAppendDouble	(	ArgList_pa	ArgList,
		const char *	Name,
		double	Value
	)

Append a double parameter to an argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	Value associated with the parameter name.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendDouble(
   &                   ArgListPtr,
   &                   Name,
   &                   Value)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    REAL*8          Value

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendDoublePtr	(	ArgList_pa	ArgList,
		const char *	Name,
		double *	Value
	)

Appends a double pointer parameter to an argument list.

Parameters:

	ArgList	The argument list
	Name	Parameter Name. Use the SV_ constants listed with the extended function
	Value	Pointer value associated with the parameter name

Returns:

Returns TRUE is append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Value Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendDoublePtr(
   &                   ArgListPtr,
   &                   Name,
   &                   Value)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    REAL*8          Value

Python Syntax:

    This function is not supported in Python.

See TecUtilStyleGetLowLevelX() for a complete example.

Boolean_t TecUtilArgListAppendFunction	(	ArgList_pa	ArgList,
		const char *	Name,
		const void *	Value
	)

Append a named function pointer to an argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	Function pointer associated with the parameter name.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Value Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendFunction(
   &                   ArgListPtr,
   &                   Name,
   &                   Value)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    POINTER         (ValuePtr, Value)

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendInt	(	ArgList_pa	ArgList,
		const char *	Name,
		LgIndex_t	Value
	)

Append an integer parameter to an argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	Value associated with the parameter name.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendInt(
   &                   ArgListPtr,
   &                   Name,
   &                   Value)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    INTEGER*4       Value

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendSet	(	ArgList_pa	ArgList,
		const char *	Name,
		Set_pa	Value
	)

Append a named set reference to an argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	Set reference associated with the parameter name. Tecplot does not make a copy of the set so the client must maintain the set until the ArgList is cleared or deallocated at which point the set can be deallocated.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

IMPLICATION(Set != NULL,VALID_REF(Set)) Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendSet(
   &                   ArgListPtr,
   &                   Name,
   &                   ValuePtr)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    POINTER         (ValuePtr, Value)

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendString	(	ArgList_pa	ArgList,
		const char *	Name,
		const char *	Value
	)

Append a string to an argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	Value	String value associated with the parameter name.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

Value Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendString(
   &                   ArgListPtr,
   &                   Name,
   &                   Value)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    CHARACTER*(*)   Value

Python Syntax:

    This function is not supported in Python.

Boolean_t TecUtilArgListAppendStringList	(	ArgList_pa	ArgList,
		const char *	Name,
		StringList_pa	StringList
	)

Append a named string list reference to an argument list.

Parameters:

	ArgList	The argument list.
	Name	Parameter name. Use the SV_constants listed with the extended function.
	StringList	String list reference associated with the parameter name. Tecplot does not make a copy of the list so the client must maintain the string list until the ArgList is cleared or deallocated at which point the string list can be deallocated.

Returns:

Returns TRUE if append is successful, FALSE otherwise.

Precondition:

ArgList Argument list must be valid.

Name String must have a valid address and non-zero length.

StringList Pointer must be a valid address and non-NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilArgListAppendStringList(
   &                   ArgListPtr,
   &                   Name,
   &                   StringListPtr)
    POINTER         (ArgListPtr, ArgList)
    CHARACTER*(*)   Name
    POINTER         (StringListPtr, StringList)

Python Syntax:

    This function is not supported in Python.

void TecUtilArgListClear

(

ArgList_pa

ArgList

)

Clear all arguments from an argument list.

Precondition:

ArgListIsValid(ArgList) Argument list must be valid.

Fortran Syntax:

    SUBROUTINE TecUtilArgListClear(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

    This function is not supported in Python.

void TecUtilArgListDealloc

(

ArgList_pa *

ArgList

)

Deallocate an argument list.

Parameters:

ArgList

The argument list.

Precondition:

ArgList Pointer must be a valid address and non-NULL.

ArgList Argument list must be valid or NULL.

Fortran Syntax:

    SUBROUTINE TecUtilArgListDealloc(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

    This function is not supported in Python.