IOleItemContainer::GetObject (Compact 2013)
3/26/2014
This method returns a pointer to the object identified by the specified name.
Syntax
HRESULT GetObject(
LPOLESTR pszItem,
DWORD dwSpeedNeeded,
IBindCtx* pbc,
REFIID riid,
void** ppvObject
);
Parameters
- pszItem
[in] Pointer to a zero-terminated string containing the container's name for the requested object. For Win32 applications, the LPOLESTR type indicates a wide character string (two bytes per character); otherwise, the string has one byte per character.
- dwSpeedNeeded
[in] Value that indicates approximately how long the caller will wait to get the object. The legal values for dwSpeedNeeded are taken from the enumeration BINDSPEED.
pbc
[in] Pointer to the IBindCtx interface on the bind context object to be used in this binding operation.The bind context caches objects bound during the binding process, contains parameters that apply to all operations using the bind context, and provides the means by which the binding implementation should retrieve information about its environment.
For more information, see IBindCtx.
- riid
[in] Reference to the identifier of the interface pointer requested.
ppvObject
[out] Address of pointer variable that receives the interface pointer requested in riid.Upon successful return, *ppvObject contains the requested interface pointer to the object named by pszItem.
When successful, the implementation must call the IUnknown::AddRef method on the *ppvObject; it is the caller's responsibility to call the IUnknown::Release method.
If an error occurs, the implementation sets *ppvObject to NULL.
Return Value
This method supports the standard return value E_OUTOFMEMORY.
The following table shows the additional return values for this method.
Value |
Description |
|---|---|
S_OK |
The specified object was successfully returned. |
MK_E_EXCEEDEDDEADLINE |
The binding operation could not be completed within the time limit specified by the bind context's BIND_OPTS structure, or with the speed indicated by the dwSpeedNeeded parameter. |
MK_E_NOOBJECT |
The parameter pszItem does not identify an object in this container. |
E_NOINTERFACE |
The requested interface was not available. |
Remarks
The item moniker implementation of IMoniker::BindToObject calls this method, passing the name stored within the item moniker as the pszItem parameter.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Notes to Implementers
Your implementation of IOleItemContainer::GetObject should first determine whether pszItem is a valid name for one of the container's objects. If not, you should return MK_E_NOOBJECT.
If pszItem names an embedded or linked object, your implementation must check the value of the dwSpeedNeeded parameter.
If the value is BINDSPEED_IMMEDIATE and the object is not yet loaded, you should return MK_E_EXCEEDEDDEADLINE.
If the object is loaded, your implementation should determine whether the object is running (for example, by calling the OleIsRunning function).
If it is not running and the dwSpeedNeeded value is BINDSPEED_MODERATE, your implementation should return MK_E_EXCEEDEDDEADLINE.
If the object is not running and dwSpeedNeeded is BINDSPEED_INDEFINITE, your implementation should call the OleRun function to put the object in the running state. Then it can query the object for the requested interface.
Note that it is important the object be running before you query for the interface.
If pszItem names a pseudo-object, your implementation can ignore the dwSpeedNeeded parameter because a pseudo-object is running whenever its container is running. In this case, your implementation can simply query for the requested interface.
If you want more specific information about the time limit than is given by dwSpeedNeeded, you can call the IBindCtx::GetBindOptions method on the pbc parameter to get the actual deadline parameter.
Requirements
Header |
objidl.h, |
Library |
ole32.lib |
See Also
Reference
IOleItemContainer
OleIsRunning
OleRun
IBindCtx
IMoniker::BindToObject
IBindCtx::GetBindOptions