Getarg

getarg

Description:

Function getarg get an argument that was passed to a function.

This function name starts with a lowercase letter.

Parameters:

(arg, index = 0)

int

arg

The argument sequence number. Use 0 for first argument.

int

index

The index (in case the argument is an array).

Return Values:

The value of the argument.

Examples:

Example 1

SomeFunc(...)
{
    printf("%i", getarg(3));
}
 
public OnFilterScriptInit()
{
    SomeFunc(1, 3, 3, 7);
}
 
// Output: 7. The fourth argument (index 3) is 7.

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• numargs: Return the number of arguments.
• setarg: Set an argument.