getArgs()

The getArgs() method returns a table that contains one row for each argument that will be accepted by the UDX.

In the database, arguments are always positional. Consequently, the first row in the returned table represents the first argument of the UDX, the second row represents the second argument, and so on.

Data types lists the data types that are accepted by a UDX written in Lua.

The getArgs() method returns a nested table in the following form:

{{ARGUMENT_1_NAME, ARGUMENT_1_TYPE},
 {ARGUMENT_2_NAME, ARGUMENT_2_TYPE},
 ...,
 {ARGUMENT_X_NAME, ARGUMENT_X_TYPE}}

Examples

function getArgs()
    local args={}
    args[1] = { "x", integer }
    args[2] = { "y", integer }
    return args
end

function getArgs()
    return {{"str", varchar(255)}}
end

function getArgs()
    return varargs
end