IVsLanguageClipboardOps.IsTextData(IDataObject) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int IsTextData(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pDO);

public:
 int IsTextData(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pDO);

int IsTextData(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pDO);

public int IsTextData (Microsoft.VisualStudio.OLE.Interop.IDataObject pDO);

abstract member IsTextData : Microsoft.VisualStudio.OLE.Interop.IDataObject -> int

Public Function IsTextData (pDO As IDataObject) As Integer

Parameters

pDO: IDataObject

[in] Pointer to the data object.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

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.

Applies to