IHxHelpPane::DisplayTask Method
The DisplayTask method displays a topic in the Help Pane based on the passed URI value. The bstrUrl parameter must specify a valid mshelp URI.
For Windows 10 and subsequent versions of the Windows operating system, this method opens a browser-based online resource instead of the Windows Help content set.
IHxHelpPane::DisplayTask(
BSTR bstrUrl
);
public void DisplayTask(
string bstrUrl
);
public overridable sub DisplayTask(
ByVal bstrUrl As String
)
Parameters
bstrUrl
[in] String that contains the URL for a task. This value must be a valid URI using the mshelp:// protocol.
Return Value
| Value | Description |
|---|---|
S_OK |
Success. |
RPC_S_SERVER_UNAVAILABLE |
The Help Pane Proxy was pre-empted and the server closed before the call could be completed. This will happen if you call the HelpPane object using the proxy object, and the HelpPane object does not respond. |
E_INVALIDARG |
The bstrUrl parameter was null, blank, or not an mshelp URI. |
Remarks
The bstrUrl parameter is limited to 2083 characters. Leading and trailing spaces are stripped before determining length.
Example
The following example demonstrates calling DisplayTask in a C++ application. This example assumes that a valid instance of the Help Pane has been created.
hr = pHelpPane->DisplayTask(L"mshelp://Windows/?id=004630d0-9241-4842-9d3f-2a0c5825ef14");
The following example demonstrates calling DisplayTask in a C# application. This example assumes that a valid instance of the Help Pane has been created.
pane.DisplayTask("mshelp://Windows/?id=004630d0-9241-4842-9d3f-2a0c5825ef14");
The following example demonstrates calling DisplayTask in a Visual Basic application. This example assumes that a valid instance of the Help Pane has been created.
objHelpPane. DisplayTask("mshelp://Windows/?id=004630d0-9241-4842-9d3f-2a0c5825ef14")