HlinkQueryCreateFromData function

[HlinkQueryCreateFromData may be altered or unavailable in subsequent versions of the operating system or product.]

Note The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

Determines if a new hyperlink can be created from an IDataObject interface.

Syntax

C++


HRESULT HlinkQueryCreateFromData(
  _In_ IDataObject* piDataObj
);

Parameters

piDataObj [in]: The address of the IDataObject interface supplying the hyperlink formats.

Return value

Returns S_OK if a hyperlink can be created from the data object, or S_FALSE if not.

Remarks

The application must call the HlinkQueryCreateFromData function to find out whether the hyperlink can be created from the data object that is obtained from the clipboard, from a drag-and-drop operation, or from any other means.

A hyperlink can be created if the IDataObject interface supports one of the following formats: cfHyperlink, cfUniformResourceLocator, CF_HDROP, or cfFileName.

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows 2000 Server
Header	Hlink.h
Library	Hlink.lib
DLL	Hlink.dll