getBooleanParameter Method (ParameterList)
In This Topic
Returns the value of the named parameter as a boolean. The value "on" is interpreted as 'true', while the value "off" is interpreted as 'false'. If the parameter has another value then an StringFormatException is thrown. If the parameter 'pname' is not in the parameter list, an IllegalArgumentException is thrown.
Syntax
'Declaration
Public Overridable Function getBooleanParameter( _
ByVal As String _
) As Boolean
public virtual bool getBooleanParameter(
string
)
Parameters
- pname
- The parameter name.
Return Value
the value of the parameter as a boolean.
Exceptions
| Exception | Description |
|---|
| StringFormatException | If the parameter has a value which is
neither "on" nor "off".
|
| IllegalArgumentException | If there is no parameter with the
name 'pname' in the parameter list.
|
See Also
