GetFriendlyName method

  • Article

[IHlinkTarget::GetFriendlyName may be altered or unavailable in subsequent versions of the operating system or product.]

Note  The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

 

Gets a display name for the given hyperlink location in the target.

Syntax

HRESULT retVal = object.GetFriendlyName(pwzLocation, ppwzFriendlyName);

Parameters

  • pwzLocation [in]
    Type: LPCWSTR

    The address of a string that specifies the position of the hyperlink destination in the hyperlink target.

  • ppwzFriendlyName [out]
    Type: LPWSTR

    A pointer to a string that receives the display name. This string must be allocated using CoTaskMemAlloc. It is the caller's responsibility to free this string using CoTaskMemFree.

See also

IHlink::GetFriendlyName