ADO Error Object HelpContext, HelpFile Property

You are here: ADO Component Reference > ADO Objects > ADO Error Object > ADO Error Object Properties > ADO Error Object HelpContext, HelpFile Property

ADO Error Object HelpContext, HelpFile Property

The help file and topic associated with an Error object. This property is not currently supported on UNIX.

HelpContext, HelpFile Property Return Values

HelpContextID

Returns a context ID, as a Long value, for a topic in a Microsoft Windows Help file.

HelpFile

Returns a String that evaluates to a fully resolved path to a Help file.

HelpContext, HelpFile Property Remarks

If a Windows Help (.hlp) file is specified in the HelpFile property, the HelpContext property is used to automatically display the Help topic it identifies. If there is no relevant help topic available, the HelpContext property returns zero and the HelpFile property returns a zero-length string ("").

HelpContext, HelpFile Property Examples

See the ADO Error Object Description Property example.