ExceptionExtensionsSetHelpTopicReference Method |
Sets an associated help topic reference on an exception object.
Namespace:
Dundas.BI
Assembly:
Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax public static Exception SetHelpTopicReference(
this Exception exception,
string helpTopicReference
)
<ExtensionAttribute>
Public Shared Function SetHelpTopicReference (
exception As Exception,
helpTopicReference As String
) As Exception
public:
[ExtensionAttribute]
static Exception^ SetHelpTopicReference(
Exception^ exception,
String^ helpTopicReference
)
[<ExtensionAttribute>]
static member SetHelpTopicReference :
exception : Exception *
helpTopicReference : string -> Exception
Parameters
- exception
- Type: SystemException
The exception. - helpTopicReference
- Type: SystemString
The help topic reference to assign to exception.
Return Value
Type:
ExceptionThe provided exception.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
Exception. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
Exceptions Remarks
The link should be relative to the value of the
HelpLinkUriFormat configuration setting.
See Also