This method sets the name of the Help file.
At a Glance
| Header file: | Oaidl.h |
| Windows CE versions: | 2.0 and later |
Syntax
HRESULT SetHelpFileName( OLECHAR FAR* szHelpFileName );
Parameters
szHelpFileName
Null-terminated string that contains the name of the Help file for the library.
Return Values
One of the values described in the following table is returned.
| Value | Description |
| S_OK | Success. |
| STG_E_INSUFFICIENTMEMORY | Out of memory. |
| E_OUTOFMEMORY | Out of memory. |
| E_INVALIDARG | One or more of the parameters is invalid. |
| TYPE_E_INVALIDSTATE | The state of the type library is not valid for this operation. |
Remarks
Each type library can reference a single Help file.
The GetDocumentation method of the created ITypeLib returns a fully qualified path for the Help file, which is formed by appending the name passed into szHelpFileName to the registered Help directory for the type library. The Help directory is registered under:
\TYPELIB\<guid of library>\<Major.Minor version >\HELPDIR