GetSiteAllParams Method

Description

Returns the properties of all site configuration parameters.

Syntax

Visual Basic
Public Function GetSiteAllParams() As String

Return Type

On success, returns an XML string containing the properties.

Return Value Details

The properties of the GetSiteAllParams XML return string:

PARAM_NAME - The parameter name.
PARAM_VALUE - The parameter value.
PARAM_DESCRIPTION - The parameter description.
PARAM_IS_SYSTEM - For internal use.

Return Value Example

<GetSiteAllParams>
    <TDXItem>
            <PARAM_NAME>ACISERVER</PARAM_NAME>
            <PARAM_VALUE>camaro.anyplace.com:9999</PARAM_VALUE>
            <PARAM_DESCRIPTION>The Demo server name and port
                number for connection. Use the format server name:port
                number.</PARAM_DESCRIPTION>
            <PARAM_IS_SYSTEM>Y</PARAM_IS_SYSTEM>
    </TDXItem>
    <TDXItem>
            <PARAM_NAME>DEMO_EVAL</PARAM_NAME>
            <PARAM_VALUE>24-17-24-0-181-118-195-219-44</PARAM_VALUE>
            <PARAM_DESCRIPTION />
            <PARAM_IS_SYSTEM>N</PARAM_IS_SYSTEM>
    </TDXItem>
</GetSiteAllParams>

Example

Example (Visual Basic)

Private Sub GetSiteAllParams()
    
'The following Visual Basic example gets the properties
'  of all the parameters.
    Dim sReply As String

    On Error GoTo err

    sReply = m_SAClient.GetSiteAllParams
    MsgBox sReply
    Exit Sub

err:
    MsgBox "Program failed:" + err.Description
End Sub