IHlink::GetFriendlyName

Retrieves the friendly name of the target. The container normally uses this name to determine how to represent the hyperlink in its user interface.

HRESULT GetFriendlyName(

DWORD grfHLFNAMEF,

// Flag specifying the friendly name to return.

LPWSTR * ppwzFriendlyName

// Buffer to receive the friendly name.

);

Parameters

grfHLFNAMEF: [in] Flag specifying the friendly name to return.
ppwzFriendlyName: [out] Pointer to the buffer to return the friendly name. This string must be allocated using CoTaskMemAlloc. It is the caller’s responsibility to free this string using CoTaskMemFree.

Return Values

S_OK: The friendly name string of the hyperlink was retrieved.

DWORD grfHLFNAMEF,	// Flag specifying the friendly name to return.
LPWSTR * ppwzFriendlyName	// Buffer to receive the friendly name.
);