IHelp.GetHelpFile(String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the name and path of the help file.

public:
 int GetHelpFile([Runtime::InteropServices::Out] System::String ^ % pbstr);

int GetHelpFile([Runtime::InteropServices::Out] std::wstring const & & pbstr);

public int GetHelpFile (out string pbstr);

abstract member GetHelpFile : string -> int

Public Function GetHelpFile (ByRef pbstr As String) As Integer

Parameters

pbstr

String

[out] String containing the name of the help file.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From objtext.idl:

HRESULT IHelp::GetHelpFile(  
   [out] BSTR* pbstr  
);