|
ITypeLib::GetDocumentation
ITypeLib::GetDocumentation(index, lpbstrName, lpbstrDocString, lpdwHelpContext, lpbstrHelpFile)
int index
BSTR FAR* lpbstrName
BSTR FAR* lpbstrDocString
unsigned long FAR* lpdwHelpContext
BSTR FAR* lpbstrHelpFile
Retrieves the library's documentation string, name of the complete Help file
path and name, and the context ID for the library Help topic in the Help file.
Parameter
index
Index of the type description whose documentation is to be returned; if index
is  1, then the documentation for the library itself is returned.
lpbstrName
Returns a BSTR that contains the name of the specified item. If the caller
does not need the item name, then lpbstrName can be NULL.
lpbstrDocString
Returns a BSTR that contains the documentation string for the specified item.
If the caller does not need the documentation string, then lpbstrDocString can be NULL.
lpdwHelpContext
Returns the Help context ID associated with the specified item. If the caller
does not need the Help context ID, then lpdwHelpContext can be NULL.
lpbstrHelpFile
Returns a BSTR that contains the fully qualified name of the Help file. If the
caller does not need the Help filename, then lpbstrHelpFile can be NULL.
Return Value
The SCODE obtained from the returned HRESULT is one of the following:
SCODE
| Meaning
| S_OK
| Success.
| STG_E_INSUFFICIENTMEMORY
| Out of memory.
| E_INVALIDARG
| One or more of the arguments is invalid.
| TYPE_E_IOERROR
| The function could not write to the file.
| TYPE_E_INVDATAREAD
| The function could not read from the file.
| TYPE_E_UNSUPFORMAT
| The type library has an old format.
| TYPE_E_INVALIDSTATE
| The type library could not be opened.
| TYPE_E_ELEMENTNOTFOUND
| The element was not found.
|
Comments
The caller should free the BSTR parameters lpbstrName, lpbstrDocString, and lpbstrHelpFile.
Example
for (i = 0; i < utypeinfoCount; i++)
{
CHECKRESULT(ptlib->GetDocumentation(i, &bstrName,
NULL, NULL, NULL));
.
.
.
SysFreeString(bstrName);
}
Related LinksSoftware for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder
More Online Helps Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages
|
