LoadXmlHelpers.TryGetHelpClassDescriptions Method

Gets the Help topic path.

Namespace: Microsoft.ConfigurationManagement.AdminConsole
Assembly: Microsoft.ConfigurationManagement (in microsoft.configurationmanagement.dll)

Usage

'Usage
Dim topicId As String
Dim helpTopic As String
Dim returnValue As Boolean

returnValue = LoadXmlHelpers.TryGetHelpClassDescriptions(topicId, helpTopic)

Syntax

'Declaration
Public Shared Function TryGetHelpClassDescriptions ( _
    topicId As String, _
    <OutAttribute> ByRef helpTopic As String _
) As Boolean

public static bool TryGetHelpClassDescriptions (
    string topicId,
    out string helpTopic
)

public:
static bool TryGetHelpClassDescriptions (
    String^ topicId, 
    [OutAttribute] String^% helpTopic
)

public static boolean TryGetHelpClassDescriptions (
    String topicId, 
    /** @attribute OutAttribute() */ /** @ref */ String helpTopic
)

Parameters

• topicId
  [in] Help identifier for the topic.

• helpTopic
  [out] Help topic path.

Return Value

true if the Help topic path is retrieved; otherwise false.

Exceptions

Exception type	Condition
ArgumentException	The topicID parameter cannot be null or an empty string.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2003, Windows Vista

Target Platforms

Windows Server 2003,Windows Vista

See Also

Reference

LoadXmlHelpers Class
LoadXmlHelpers Members
Microsoft.ConfigurationManagement.AdminConsole Namespace