ITypeLib2.GetDocumentation2(Int32, String, Int32, String) Método

Definición

Espacio de nombres:

System.Runtime.InteropServices.ComTypes

Ensamblado:

System.Runtime.InteropServices.dll

Recupera la cadena de documentación de la biblioteca, el nombre completo del archivo de ayuda y la ruta de acceso, el contexto de localización que se utiliza y el identificador de contexto para el tema de Ayuda de la biblioteca en el archivo de ayuda.

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)

Parámetros

index

Int32

Índice de la descripción de tipo cuya documentación se va a devolver; si index es -1, la documentación de la biblioteca se devuelve.

pbstrHelpString

String

Cuando este método devuelve un resultado, contiene un BSTR que especifica el nombre del elemento especificado. Si el autor de la llamada no necesita el nombre de elemento, pbstrHelpString puede ser null. Este parámetro se pasa sin inicializar.

pdwHelpStringContext

Int32

Cuando este método devuelve un resultado, contiene el contexto de localización de la ayuda. Si el autor de la llamada no necesita el contexto de ayuda, pdwHelpStringContext puede ser null. Este parámetro se pasa sin inicializar.

pbstrHelpStringDll

String

Cuando este método devuelve un resultado, contiene un BSTR que especifica el nombre completo del archivo que contiene la DLL que se utiliza para el archivo de ayuda. Si el autor de la llamada no necesita el nombre de archivo, pbstrHelpStringDll puede ser null. Este parámetro se pasa sin inicializar.