IBindCtx::RevokeObjectParam (Compact 2013)

3/26/2014

This method removes the specified key and its associated pointer from the bind context's string-keyed table of objects. The key must have previously been inserted into the table with a call to the IBindCtx::RegisterObjectParam method.

Syntax

HRESULT RevokeObjectParam(
  LPOLESTR pszKey
);

Parameters

  • pszKey
    [in] Pointer to a zero-terminated wide character string (two bytes per character) containing the key to remove. Key string comparison is case-sensitive.

Return Value

The following table shows the return values for this method.

Value

Description

S_OK

The specified key was successfully removed from the table.

S_FALSE

No object has been registered with the specified key.

Remarks

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.

This method is used to remove an entry from the table. If the specified key is found, the bind context also releases its reference to the object.

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

Requirements

Header

objidl.h,
objidl.idl

Library

ole32.lib,
uuid.lib

See Also

Reference

IBindCtx
IBindCtx::RegisterObjectParam