IBindCtx::EnumObjectParam
A version of this page is also available for
4/8/2010
This method supplies a pointer to an IEnumString interface on an enumerator that can return the keys of the bind context's string-keyed table of pointers.
The IBindCtx::EnumObjectParam method is supported in DCOM, but it is not supported in COM.
Calling this method in COM returns a value of E_NOTIMPL.
Syntax
HRESULT EnumObjectParam(
IEnumString** ppenum
);
Parameters
ppenum
[out] Address of the IEnumString* pointer variable that receives the interface pointer to the enumerator.If an error occurs, *ppenum is set to NULL.
If *ppenum is non-NULL, the implementation calls the IUnknown::AddRef method on the *ppenum.
It is the caller's responsibility to call the IUnknown::Release method.
Return Value
The following table shows the return values for this method.
| Value | Description |
|---|---|
E_NOTIMPL |
The method is not currently implemented. |
E_OUTOFMEMORY |
A standard return value. |
S_OK |
An enumerator was successfully created and the pointer supplied. |
Remarks
This method provides an IEnumString pointer to an enumerator that can return the keys of the bind context's string-keyed table of pointers.
The keys returned are the same as previously specified in calls to the IBindCtx::RegisterObjectParam method.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Notes to Callers
A bind context maintains a table of interface pointers, each associated with a string key. This enables communication between a moniker implementation and the caller that initiated the binding operation.
One party can store an interface pointer under a string known to both parties so that the other party can later retrieve it from the bind context.
Requirements
| Header | objidl.h, objidl.idl |
| Library | ole32.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
IBindCtx
IEnumString
IBindCtx::RegisterObjectParam
IUnknown::AddRef
IUnknown::Release