IHlink::GetStringReference

IHlink::GetStringReference

Retrieves strings that identify the hyperlink target and the location within the hyperlink target.

HRESULT GetStringReference(

    DWORD

dwWhichRef,            // Absolute or relative reference

    LPWSTR * pszTarget,          // Receives the string that helps identify the hyperlink target

    LPWSTR * pszLocation         // Receives the location portion of the hyperlink target

);

Parameters

dwWhichRef

[in] Value from the HLINKGETREF enumeration specifying whether to get the absolute or relative reference to the hyperlink target.

pszTarget

[out] On return, points to a string that helps identify the hyperlink target of the hyperlink reference. If NULL, the caller is not interested in the target string of the hyperlink reference.

pszLocation

[out] On return, points to the location portion of the hyperlink reference. If NULL, the caller is not interested in the location portion of the hyperlink reference.

Return Values

S_OK

Indicates the target and location strings of the hyperlink target have been successfully supplied.