Business Analyst Online API for Silverlight 2.2 Reference
SetOptionalParameter Method
See Also Send Feedback

ESRI.ArcGIS.Client.BACore.Client Namespace > BATaskUtils Class : SetOptionalParameter Method

Visual Basic (Declaration)
C#

variables: Request variables to set the parameter for.

obj: An object to get the parameter from.

name: Parameter name.

defaultValue: Default value to be used if the parameter value is empty or missing.

Sets an optional parameter with the given name and default value.

Syntax

Visual Basic (Declaration)

Public Shared Sub SetOptionalParameter( _
   ByVal variables As IDictionary(Of String,String), _
   ByVal obj As Object, _
   ByVal name As String, _
   ByVal defaultValue As Object _
)

public static void SetOptionalParameter( 
   IDictionary<string,string> variables,
   object obj,
   string name,
   object defaultValue
)

Parameters

variables: Request variables to set the parameter for.
obj: An object to get the parameter from.
name: Parameter name.
defaultValue: Default value to be used if the parameter value is empty or missing.

Exceptions

Exception	Description
BARequestError	Failed to set variable because its value has no overriden ToString method or the ToString method failed.

Remarks

The parameter is set if its value or default value is nonempty.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

Syntax

Parameters

Exceptions

Remarks

Requirements

See Also

Reference