GetSiteSingleParam Method

Description

Returns the properties of one site configuration parameter.

Syntax

Visual Basic
Public Function GetSiteSingleParam( _ ByVal ParamName As String, _ ByVal AppType As Integer _ ) As String

Parameters

ParamName: The parameter name.
AppType: For future use. Pass one (1).

Return Type

On success, returns an XML string containing the property.

Return Value Details

The properties of the GetSiteSingleParam 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

<GetSiteSingleParam>
    <PARAM_NAME>Param1</PARAM_NAME>
    <PARAM_VALUE>param1_value</PARAM_VALUE>
    <PARAM_DESCRIPTION> param1_desc</PARAM_DESCRIPTION>
    <PARAM_IS_SYSTEM>N</PARAM_IS_SYSTEM>
</GetSiteSingleParam>

Example

Example (Visual Basic)

Private Sub GetSiteSingleParam()

'The following Visual Basic example gets the properties
'  of the ACI_SERVER parameter.
    Dim sReply As String

    On Error GoTo err

    sReply = m_SAClient.GetSiteSingleParam _
        ("ACISERVER", 1)

    MsgBox sReply
    Exit Sub

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