IHlinkTarget::GetMoniker

Returns a moniker to the hyperlink target object for the given hyperlink destination szLocation.

HRESULT GetMoniker(
  LPCWSTR pwzLocation,  //Hyperlink destination within this target
  DWORD dwAssign,       //Whether or not to create a moniker if one 
                        //not found
  IMoniker * ppimkLocation  //Buffer to receive this moniker
);
 

Parameters

pwzLocation

[in, unique] Identifies the hyperlink destination within this target.

dwAssign

[in] A value from the OLEGETMONIKER enumeration. This is typically either OLEGETMONIKER_ONLYIFTHERE, indicating the function should not force a moniker to be created if one does not already exist, or OLEGETMONIKER_FORCEASSIGN, indicating that the function should create a moniker if one does not exist.

ppimkLocation

[out] Pointer to location to return the IMoniker interface pointer to the hyperlink target object for this szLocation.

Return Values

S_OK

The moniker to the hyperlink target object retrieved.

E_FAIL

A moniker does not exist for this hyperlink target and OLEGETMONIKER_ONLYIFTHERE was specified for dwAssign.

CreateFileMoniker, MkParseDisplayName, and other moniker creation API errors

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in hlink.h.

See Also

HlinkSimpleNavigateToMoniker, IHlink::GetMonikerReference, IHlinkSite::GetMoniker