ICreateTypeLib::SetHelpFileName
A version of this page is also available for
4/8/2010
This method sets the name of the Help file.
Syntax
HRESULT SetHelpFileName(
OLECHAR FAR* szHelpFileName
);
Parameters
- szHelpFileName
[in] Null-terminated string that contains the name of the Help file for the library.
Return Value
The following table shows the return values for this function.
| 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 ITypeLib::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 the following.
\TYPELIB\<guid of library>\<Major.Minor version >\HELPDIR
Requirements
| Header | oaidl.h, oaidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |