IErrorInfo::GetHelpContext

OLE DB Programmer's Reference

Returns the Help context ID for the error.

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 shipped with the MDAC SDK calls IErrorLookup::GetHelpInfo to retrieve the Help context ID.

See Also

IErrorInfo::GetHelpFile | IErrorLookup::GetHelpInfo

1998-2001 Microsoft Corporation. All rights reserved.



Microsoft Ole Db 2.0 Programmer's Reference and Data Access SDK
Microsoft OLE DB 2.0 Programmers Reference and Data Access SDK (Microsoft Professional Editions)
ISBN: 0735605904
EAN: 2147483647
Year: 1998
Pages: 1083

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net