IBindCtx::EnumObjectParam method (objidl.h)

Article
02/22/2024

Retrieves a pointer to an interface that can be used to enumerate the keys of the bind context's string-keyed table of pointers.

Syntax

HRESULT EnumObjectParam(
  [out] IEnumString **ppenum
);

Parameters

[out] ppenum

The address of an 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 AddRef on *ppenum; it is the caller's responsibility to call Release.

Return value

This method can return the standard return values E_OUTOFMEMORY and S_OK.

Remarks

The keys returned by the enumerator are the ones previously specified in calls to IBindCtx::RegisterObjectParam.

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.

In the system implementation of the IBindCtx interface, this method is not implemented. Therefore, calling this method results in a return value of E_NOTIMPL.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	objidl.h