IHlink::GetFriendlyName Method

---

Retrieves the display name of the target.

Syntax

HRESULT GetFriendlyName(
    DWORD grfHLFNAMEF,          
    LPWSTR *ppwzFriendlyName    
); 

Parameters

grfHLFNAMEF

[in] HLFNAMEF-defined flag value that specifies the display name to return.

ppwzFriendlyName

[out] 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.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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

Windows CE

Windows CE	Use version 2.12 and later
Minimum availability	Internet Explorer 4.0