TCPIP_HTTP_NET_SSIVariableGetByIndex Function

C

const char* TCPIP_HTTP_NET_SSIVariableGetByIndex(
    int varIndex, 
    const char** pVarName, 
    TCPIP_HTTP_DYN_ARG_TYPE* pVarType, 
    int32_t* pVarInt
);

Description

This function accesses the corresponding SSI variable by its index and returns a pointer to the variable string representation.

Preconditions

The HTTP module should have been initialized. SSI should be enabled.

Parameters


Parameters	Description
varIndex	The index of the SSI variable to search for should be TCPIP_HTTP_NET_SSIVariablesNumberGet().
pVarName	Address to store a pointer to the variable name.
pVarType	Address to store the type of the SSI variable.
pVarInt	Address to store the integer value of this variable if the variable exists and is an integer, else this address won't be modified. Could be NULL if not needed.

Returns

A valid pointer to the SSI variable string representation if the variable was found.
0 if there is no variable with such name.

Remarks

The returned value points to the internal SSI variable representation. This pointer should not be used for changing the SSI variable value.

The pVarName points to to the internal SSI variable name representation. This pointer MUST NOT be used for changing the SSI variable name.