IBindCtx::GetBindOptions

Article
06/30/2006

This method returns the binding options stored in this bind context.

HRESULT GetBindOptions(
  BIND_OPTS* pbindopts
);

Parameters

pbindopts
[in, out] Pointer to an initialized BIND_OPTS or BIND_OPTS2 structure on entry that receives the current binding parameters on return.

Return Values

The following table shows the return values for this method.

Value	Description
E_INVALIDARG	One or more arguments are incorrect.
S_OK	The stored binding options were successfully returned.

Remarks

A bind context contains a block of parameters, stored in a BIND_OPTS structure, that are common to most IMoniker operations and that do not change as the operation moves from piece to piece of a composite moniker.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Notes to Callers

You typically call this method if you are writing your own moniker class. (This requires that you implement the IMoniker interface.) You call this method to retrieve the parameters specified by the moniker client.

You must initialize the BIND_OPTS structure that is filled in by this method. Before calling this method, you must initialize the cbStruct field of the structure to the size of the BIND_OPTS structure.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Objidl.h, Objidl.idl.
Link Library: Ole32.lib, Uuid.lib.

Share via