IOleObject::SetHostNames
Provides an object with the name of its container application and the compound
document in which it is embedded.
HRESULT SetHostNames(
LPCOLESTR szContainerApp,
| //Pointer to name of container application
|
LPCOLESTR szContainerObj
| //Pointer to name of container document
|
);
|
|
Parameters
szContainerApp
[in] Points to the name of the container application in which the object is
running.
szContainerObj
[in] Points to the name of the compound document that contains the object. If
you do not wish to display the name of the compound document, you can set this
parameter to NULL.
Return Value
S_OK
Window title information set successfully.
Comments
When a container initializes an embedded object, it calls this function to
inform the object of the names of both the container application and container
document. When the object is opened for editing, it displays these names in the
title bar of its window.
Notes to Callers
Call
SetHostNames only for embedded objects, because for linked objects, the link source
supplies its own separate editing window and title bar information.
Notes to Implementors
An object's application of
SetHostNames should include whatever modifications to its user interface may be
appropriate to an object's embedded state. Such modifications typically will include
adding and removing menu commands and altering the text displayed in the title bar
of the editing window.
The complete window title for an embedded object in an SDI container
application or an MDI application with a maximized child window should appear as follows:
<
object application name> - <
object short type> in <
container document>
Otherwise, the title should be:
<
object application name>
<
container document>
The "object short type" refers to a form of an object's name short enough to
be displayed in full in a list box.
Since these identifying strings are not stored as part of the persistent state
of the object,
IOleObject::SetHostNames must be called each time the object loads or runs.
See Also
IOleObject::GetUserType
- Software for developers
-
Delphi Components
.Net Components
Software for Android Developers
- More information resources
-
MegaDetailed.Net
Unix Manual Pages
Delphi Examples
- Databases for Amazon shops developers
-
Amazon Categories Database
Browse Nodes Database