ICreateTypeLib::SetHelpFileName

HRESULT SetHelpFileName(
  OLECHAR FAR*  szHelpFileName  
);

Sets the name of the Help file.

Parameter

szHelpFileName: The name of the Help file for the library.

Return Value

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

Return value	Meaning
S_OK	Success.
STG_E_INSUFFICIENTMEMORY	Out of memory.
E_OUTOFMEMORY	Out of memory.
E_INVALIDARG	One or more of the arguments is invalid.
TYPE_E_INVALIDSTATE	The state of the type library is not valid for this operation.

Comments

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