IHTMLDataTransfer::setData Method

---

Specifies which data format to add to the system clipboard through the IHTML::DataTransfer object.

Syntax

HRESULT setData(
   BSTR format,
   VARIANT *data,
   VARIANT_BOOL *pret
);

Parameters

format

String (BSTR) that specifies the data format to add to the system clipboard using the IHTML::DataTransfer object.

For more information, see the DHTML setData method.

data

Address of a VARIANT structure that returns descriptive text, a source path to an image, or a URL for an anchor. It is required when the string value URL is passed as the sDataFormat parameter in order to provide the location of the object being transferred.

pret

Address of a VARIANT Boolean structure that returns VARIANT_TRUE or VARIANT_FALSE based on the success or failure of the call to setData.

Return Value

Returns S_OK if successful, or an error code otherwise.