MonikerRelativePathTo

HRESULT MonikerRelativePathTo(pmkSrc, pmkDest, ppmkRelPath, reserved)

This function is intended solely for the use of moniker implementors; clients of monikers "need not apply;" clients should instead compute the relative path between two monikers by using:


     pmkSrc->RelativePathTo(pmkDest, ppmkRelPath);

Implementations of IMoniker::RelativePathTo necessarily call MonikerRelativePathTo as part of their internal processing. Such a method should first check to see if the other moniker is a type that it recognizes and handles specially. If not, it should call MonikerRelativePathTo, passing itself as pmkSrc and the other moniker as pmkDest. MonikerRelativePathTo will handle the generic composite cases correctly.

Argument

Type

Description

pmkSrc

IMoniker*

The starting moniker for the computation of the relative path.

pmkDest

IMoniker*

The moniker to which a relative path should be taken.

ppmkRelPath

IMoniker**

May not be NULL. The place at which the moniker of pmkDest relative to pmkSrc is to be returned.

reserved

BOOL

NOTE Must be non-zero

return value

HRESULT

S_OK, MK_S_HIM