IHlinkTarget::GetFriendlyName

Retrieves a friendly name for the given hyperlink destination within this target.

HRESULT GetFriendlyName(

LPCWSTR pwzLocation,

// Hyperlink location within this target

LPWSTR * ppwzFriendlyName

// Buffer to receive the friendly name

);

Parameters

pwzLocation
[in, unique] String that indicates the position of the hyperlink destination within this hyperlink target.
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 destination with this target has been retrieved.
E_OUTOFMEMORY
Indicates there is insufficient memory to retrieve the friendly name.

See Also

IHlink::GetFriendlyName