AccessibleObject.GetHelpTopic(String) Metoda

Definicja

Pobiera identyfikator tematu pomocy oraz ścieżkę do pliku pomocy skojarzonego z tym dostępnym obiektem.Gets an identifier for a Help topic identifier and the path to the Help file associated with this accessible object.

public:
 virtual int GetHelpTopic([Runtime::InteropServices::Out] System::String ^ % fileName);
public virtual int GetHelpTopic (out string? fileName);
public virtual int GetHelpTopic (out string fileName);
abstract member GetHelpTopic : string -> int
override this.GetHelpTopic : string -> int
Public Overridable Function GetHelpTopic (ByRef fileName As String) As Integer

Parametry

fileName
String

W przypadku powrotu ta właściwość zawiera ścieżkę do pliku pomocy skojarzonego z tym dostępnym obiektem.On return, this property contains the path to the Help file associated with this accessible object.

Zwraca

Int32

Identyfikator tematu pomocy lub-1, jeśli nie ma tematu pomocy.An identifier for a Help topic, or -1 if there is no Help topic. W przypadku powrotu fileName parametr zawiera ścieżkę do pliku pomocy skojarzonego z tym dostępnym obiektem.On return, the fileName parameter contains the path to the Help file associated with this accessible object.

Wyjątki

Nie można pobrać tematu pomocy dla formantu.The Help topic for the control cannot be retrieved.

Uwagi

Aby wyświetlić pomoc dotyczącą AccessibleObject korzystania z systemu pomocy systemu Windows, można przekazać nazwę pliku i identyfikator tematu do odpowiedniej Help.ShowHelp metody Help .To display help for the AccessibleObject using the Windows Help system, you can pass the file name and topic ID to the appropriate Help.ShowHelp method of Help.

Uwagi dotyczące dziedziczenia

Nie wszystkie obiekty muszą obsługiwać tę właściwość.Not all objects need to support this property.

Dotyczy

Zobacz też