ICreateErrorInfo::SetHelpContext

HRESULT SetHelpContext(

DWORD  dwHelpContext  
);
 

Sets the Help context identifier (ID) for the error.

Parameter

dwHelpContext
The Help context ID for the error.

Return Value

The return value obtained from the returned HRESULT is one of the following:

Return value Meaning
S_OK Success.
E_OUTOFMEMORY Insufficient memory to complete the operation.

Comments

ICreateErrorInfo::SetHelpContext sets the Help context ID for the error. To establish the Help file to which it applies, use ICreateErrorInfo::SetHelpFile.

Example

hr = CreateErrorInfo(&pcerrinfo);
pcerrinfo->SetHelpContext(dwhelpcontext);