IVsLanguageClipboardOps::IsTextData Method (IDataObject^)

Visual Studio 2015

Determines whether the data object contains data that can be rendered into text.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int IsTextData(
	IDataObject^ pDO
)

Parameters

pDO: Type: Microsoft.VisualStudio.OLE.Interop::IDataObject^
[in] Pointer to the data object.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsLanguageClipboardOps::IsTextData(
   [in] IDataObject *pDO
);

Use this method to evaluate whether the data object is of appropriate format for your application. If you are able to read the format of the data object and translate this format into text, then return S_OK. The environment then calls TextFromData to prompt you to generate text from out of the data object.