SetSiteSingleParam Method

Description

Sets the properties of one site configuration parameter.

Syntax

Visual Basic
Public Function SetSiteSingleParam( _ ByVal ParamName As String, _ ByVal ParamValue As String, _ ByVal ParamDescription As String _ ) As String

Parameters

ParamName: The parameter name is case-sensitive.
ParamValue: The new parameter value.
ParamDescription: The new parameter description.

Return Type

Returns "1" on success.

Example

Example (Visual Basic)

Private Sub SetSiteSingleParam()

'The following Visual Basic example sets the properties
'  of an existing parameter, the mail format.
    Dim sReply As String
    On Error GoTo err

sReply = m_SAClient.SetSiteSingleParam("MAIL_FORMAT", _
        "HTML", "The mail format ")
    MsgBox sReply
    Exit Sub
err:
    MsgBox "Program failed:" + err.Description
End Sub