GetFriendlyName method

[IHlink::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 the display name of the target.

Syntax

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

Parameters

  • grfHLFNAMEF [in]
    Type: DWORD

    An HLFNAMEF-defined flag value that specifies the display name to return.

  • ppwzFriendlyName [out]
    Type: LPWSTR

    The address of the buffer to receive the display name. This string must be allocated using CoTaskMemAlloc. It is the caller's responsibility to free this string using CoTaskMemFree.

Remarks

The container typically uses the display name to determine how to represent the hyperlink in its user interface.