IHlink::SetStringReference

Sets the target string or location string values for a hyperlink object.

HRESULT SetStringReference(
  DWORD grfHLSETF,    //Specifies whether to set the hyperlink 
                      //target, the location within the target, or 
                      //both.
  LPCWSTR pwzTarget,  //Target name for the hyperlink
  LPCWSTR pwzLocation //Location within the hyperlink target of new 
                      //hyperlink
);
 

Parameters

grfHLSETF

[in] Specifies whether to set the hyperlink target, the location within the target, or both.

pwzTarget

[in, unique] The string target name for the hyperlink.

pwzLocation

[in, unique] A string identifying the location within the hyperlink target that was navigated to. Must not be NULL.

Return Values

S_OK

The string reference of the hyperlink was set.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in hlink.h.

See Also

HLINKSETF