IBindCtx::GetBindOptions method (objidl.h)

Article
02/22/2024

Retrieves the binding options stored in this bind context.

Syntax

HRESULT GetBindOptions(
  [in, out] BIND_OPTS *pbindopts
);

Parameters

[in, out] pbindopts

A pointer to an initialized structure that receives the current binding parameters on return. See BIND_OPTS3.

Return value

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

Remarks

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

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 structure that is filled in by this method. Before calling this method, you must initialize the cbStruct member to the size of the structure.

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