NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

Exception.SetHelpLink

Sets the HelpLink property of this exception.

[Visual Basic]
Overridable Public Function SetHelpLink( _
   ByVal helpLink As String _
) As Exception
[C#]
public virtual Exception SetHelpLink(
   string helpLink
);
[C++]
public: virtual Exception* SetHelpLink(
   String* helpLink
);
[JScript]
public function SetHelpLink(
   helpLink : String
) : Exception;

Parameters

helpLink
The string used for the URL or URN.

Return Value

A reference to this instance after setting the specified HelpLink property.

Remarks

SetHelpLink sets the help link for this exception. This should be in an URL or URN form, such as:

"file://C:/Applications Bazzal/help.html#ErrorNum42"

A common usage is given below in the example.

For syntactic reasons, a separate set method has been provided, instead of making the HelpLink property read-write. Please see the discussion for the ErrorCode property for the reason behind this design choice.

Example

throw new
Exception ("Program busted")::SetErrorCode (0x42)::SetHelpLink
("http://foo.com/help.html");

See Also

Exception Class | Exception Members | System Namespace