Поделиться через


IErrorInfo::GetHelpContext

Returns the Help context ID for the error.

Syntax

HRESULT GetHelpContext (
   DWORD *pdwHelpContext);

Parameters

  • pdwHelpContext
    [out] A pointer to memory in which to return the Help context ID for the error. If there is no Help file (*pbstrHelpFile returned by IErrorInfo::GetHelpFile is a null pointer), the returned value has no meaning.

Return Code

  • S_OK
    The method succeeded.

  • E_INVALIDARG
    pdwHelpContext was a null pointer.

  • DB_E_NOLOCALE
    The locale ID specified by the lcid parameter in IErrorRecords::GetErrorInfo was not supported by the provider.

Comments

The implementation of this method in the data access technologies calls IErrorLookup::GetHelpInfo to retrieve the Help context ID.

See Also

Reference

IErrorInfo::GetHelpFile

IErrorLookup::GetHelpInfo