IHlinkSite::GetMoniker

IHlinkSite::GetMoniker

Returns the relative moniker of the hyperlinkÆs container.

HRESULT GetMoniker(

    DWORD

dwSiteData,         // Site data for the new hyperlink object

    DWORD dwAssign,           // Whether or not to create a moniker if one not found

    DWORD dwWhich,            // Which moniker to retrieve

    IMoniker ** ppmk          // Buffer to receive the requested moniker interface pointer

);

Parameters

dwSiteData

[in] Identifies the hyperlink to the hyperlink site. The hyperlink site initializes the hyperlink with this value as part of IHlink::SetHlinkSite.

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.

dwWhich

[in] A value from the OLEWHICHMK enumeration. This is typically OLEWHICHMK_CONTAINER, indicating that the site should return the moniker of the hyperlink container.

ppmk

[out] Location to return the IMoniker interface.

Return Values

S_OK

Indicates the moniker of the hyperlinkÆs site container was successfully supplied.

E_FAIL

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