TCPIP_HTTP_NET_SSIVariableGet Function

C

const char* TCPIP_HTTP_NET_SSIVariableGet(
    const char* varName, 
    TCPIP_HTTP_DYN_ARG_TYPE* pVarType, 
    int32_t* pVarInt
);

Description

This function performs a search for the corresponding SSI variable name and returns a pointer to the variable string representation.

Preconditions

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

Parameters

ParametersDescription
varNameThe SSI variable to search for.
pVarTypeAddress to store the type of the SSI variable.
pVarIntAddress 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.