IBindCtx::GetObjectParam - OLE Programmer's Reference

OLE Programmer's Reference

Home Index About

Custom Search

IBindCtx::GetObjectParam

Retrieves the pointer associated with the specified key in the bind context's string-keyed table of pointers.

HRESULT GetObjectParam(

LPOLESTR pszKey,	//Points to the key to be used
IUnknown **ppunk	//Receives a pointer to the object associated with the key
);

Parameters
pszKey

[in] Points to a zero-terminated string containing the key to search for. For Win32 applications, the LPOLESTR type indicates a wide character string (two bytes per character); otherwise, the string has one byte per character. Key string comparison is case sensitive.

ppunk

[out] Receives a pointer to the object associated with pszKey. If an error occurs, *ppunk is set to NULL. If *ppunk is non-NULL, the implementation calls IUnknown::AddRef on the parameter; it is the caller's responsibility to call IUnknown::Release.

Return Values
S_OK

The pointer associated with the specified key was successfully returned.

E_FAIL

Indicates that no object has been registered with the specified key.

Comments
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.

The pointer this method retrieves must have previously been inserted into the table using the IBindCtx::RegisterObjectParam method.

Notes to Callers
You can call IBindCtx::GetObjectParam if you are either a moniker implementor or a sophisticated moniker client.

If you are a moniker client, you can call this method if a binding operation failed to get specific information about the error that occurred. Depending on the error, you may be able to correct the situation and retry the binding operation. See IBindCtx::RegisterObjectParam for more information.

If you are a moniker implementor, you can call this method to retrieve information specified by the caller that initiated the binding operation. By convention, you should use key names that begin with the string form of the CLSID of your moniker class (see the StringFromCLSID API function).

See Also
IBindCtx::RegisterObjectParam, IBindCtx::EnumObjectParam

Last news from Greatis Software

    Nostalgia .Net     .Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More »

Recommended software for developers

    Ultimate Pack     Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More »

    Form Designer .Net     Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More »

    Print Suite .Net     Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More »

    Gradient Controls .Net     Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More »

    Greatis iGrid     iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More »

All the contacts and projects

Dmitry Vasiliev (just.dmitry)

More Online Helps

Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages

greatis just4fun network