ITypeLib2.GetDocumentation2(Int32, String, Int32, String) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Позволяет получить строку документирования библиотеки, полное имя файла справки и путь к нему, контекст локализации, который следует использовать, и идентификатор контекста для раздела справки библиотеки в файле справки.
public:
void GetDocumentation2(int index, [Runtime::InteropServices::Out] System::String ^ % pbstrHelpString, [Runtime::InteropServices::Out] int % pdwHelpStringContext, [Runtime::InteropServices::Out] System::String ^ % pbstrHelpStringDll);
public void GetDocumentation2 (int index, out string pbstrHelpString, out int pdwHelpStringContext, out string pbstrHelpStringDll);
abstract member GetDocumentation2 : int * string * int * string -> unit
Public Sub GetDocumentation2 (index As Integer, ByRef pbstrHelpString As String, ByRef pdwHelpStringContext As Integer, ByRef pbstrHelpStringDll As String)
Параметры
- index
- Int32
Индекс описания типа, документация по которому должна быть возвращена. Если параметр index
имеет значение -1, документация библиотеки возвращается.
- pbstrHelpString
- String
При возвращении этот метод содержит параметр BSTR с именем указанного элемента. Если вызывающему объекту не требуется имя элемента, параметр pbstrHelpString
может иметь значение null
. Этот параметр передается неинициализированным.
- pdwHelpStringContext
- Int32
После выполнения возврата этим методом содержит контекст локализации справки. Если вызывающему объекту не требуется контекст справки, параметр pdwHelpStringContext
может иметь значение null
. Этот параметр передается неинициализированным.
- pbstrHelpStringDll
- String
После выполнения возврата этим методом содержит параметр BSTR, указывающий полное имя файла, который, в свою очередь, содержит библиотеку DLL, используемую для файла справки. Если вызывающему объекту не требуется имя файла, параметр pbstrHelpStringDll
может иметь значение null
. Этот параметр передается неинициализированным.