Share via

IMoniker::Reduce (Compact 2013)

  • Article

3/26/2014

This method reduces the moniker to the simplest form.

Syntax

HRESULT Reduce( 
  IBindCtx* pbc, 
  DWORD dwReduceHowFar, 
  IMoniker** ppmkToLeft,
  IMoniker** ppmkReduced
);

Parameters

  • pbc
    [in] Pointer to the IBindCtx interface on the bind context to be used in this binding operation.

    The bind context caches objects bound during the binding process, contains parameters that apply to all operations using the bind context, and provides the means by which the moniker implementation should retrieve information about its environment.

    For more information, see IBindCtx.

  • dwReduceHowFar
    [in] Value that specifies how far this moniker should be reduced. This parameter must be one of the values from the MKRREDUCE enumeration.

  • ppmkToLeft
    [in, out] On entry, address of IMoniker* pointer variable that contains the interface pointer to moniker to the left of this moniker.

    This parameter is primarily used by moniker implementers to enable cooperation between the various components of a composite moniker; moniker clients can usually pass NULL.

    On return, *ppmkToLeft is usually set to NULL, that indicates no change in the original moniker to the left.

    In rare situations, *ppmkToLeft indicates a moniker, that indicates that the previous moniker to the left should be disregarded and the moniker returned through *ppmkToLeft is the replacement.

    In such a situation, the implementation must call the IUnknown::Release method on the old moniker to the left of this moniker and must call the IUnknown::AddRef method on the new returned moniker; the caller must release it later.

    If an error occurs, the implementation can either leave the interface pointer unchanged or set it to NULL.

  • ppmkReduced
    [out] Address of IMoniker* pointer variable that receives the interface pointer to the reduced form of this moniker, which can be NULL if an error occurs or if this moniker is reduced to nothing.

    If this moniker cannot be reduced, *ppmkReduced is simply set to this moniker and the return value is MK_S_REDUCED_TO_SELF.

    If *ppmkReduced is non-NULL, the implementation must call IUnknown::AddRef on the new moniker; it is the caller's responsibility to call IUnknown::Release. (This is true even if *ppmkReduced is set to this moniker.)

Return Value

The method supports the standard return values E_UNEXPECTED and E_OUTOFMEMORY.

The following table shows the additional return values for this method.

Value

Description

S_OK

This moniker was reduced.

MK_S_REDUCED_TO_SELF

This moniker could not be reduced any further, so ppmkReduced indicates this moniker.

MK_E_EXCEEDEDDEADLINE

The operation could not be completed within the time limit specified by the bind context's BIND_OPTS structure.

Remarks

IMoniker::Reduce is intended for the following uses:

  • It enables the construction of user-defined macros or aliases as new kinds of moniker classes. When reduced, the moniker to which the macro evaluates is returned.
  • It enables the construction of a kind of moniker that tracks data as it moves about. When reduced, the moniker of the data in its current location is returned.
  • On file systems that support an identifier-based method of accessing files that is independent of file names; a file moniker could be reduced to a moniker that contains one of these identifiers.

The intent of the MKRREDUCE flags passed in the dwReduceHowFar parameter is to provide the ability to programmatically reduce a moniker to a form whose display name is recognizable to the user.

For example, paths in the file system, bookmarks in word-processing documents, and range names in spreadsheets are all recognizable to users. In contrast, a macro or an alias encapsulated in a moniker are not recognizable to users.

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

Notes to Callers

The scenarios described above are not currently implemented by the system-supplied moniker classes.

You should call IMoniker::Reduce before comparing two monikers using the IMoniker::IsEqual method, because a reduced moniker is in its most specific form. IMoniker::IsEqual may return S_FALSE on two monikers before they are reduced and return S_OK after they are reduced.

Notes to Implementers

If the current moniker can be reduced, your implementation must not reduce the moniker in-place.

Instead, it must return a new moniker that represents the reduced state of the current one. This way, the caller still has the option of using the non-reduced moniker (for example, enumerating its components).

Your implementation should reduce the moniker at least as far as is requested.

Requirements

Header

objidl.h,
objidl.idl

Library

ole32.lib,
uuid.lib

See Also

Reference

IMoniker
IMoniker::IsEqual
IUnknown::AddRef
IUnknown::Release
BIND_OPTS