IVsDataObjectStringMapManager.WriteStringMap Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Writes information to a string map.

public:
 int WriteStringMap(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pObject, System::String ^ szStringMapName, int fOverwriteExisting, Microsoft::VisualStudio::Shell::Interop::IVsStringMap ^ pStringMap);

public:
 int WriteStringMap(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pObject, Platform::String ^ szStringMapName, int fOverwriteExisting, Microsoft::VisualStudio::Shell::Interop::IVsStringMap ^ pStringMap);

int WriteStringMap(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pObject, std::wstring const & szStringMapName, int fOverwriteExisting, Microsoft::VisualStudio::Shell::Interop::IVsStringMap const & pStringMap);

public int WriteStringMap (Microsoft.VisualStudio.OLE.Interop.IDataObject pObject, string szStringMapName, int fOverwriteExisting, Microsoft.VisualStudio.Shell.Interop.IVsStringMap pStringMap);

abstract member WriteStringMap : Microsoft.VisualStudio.OLE.Interop.IDataObject * string * int * Microsoft.VisualStudio.Shell.Interop.IVsStringMap -> int

Public Function WriteStringMap (pObject As IDataObject, szStringMapName As String, fOverwriteExisting As Integer, pStringMap As IVsStringMap) As Integer

Parameters

pObject: IDataObject

[in] An IDataObject that contains the string maps.

szStringMapName: String

[in] The name of the string map to write.

fOverwriteExisting: Int32

[in] Set to true if the new information should overwrite existing information.

pStringMap: IVsStringMap

[in] An IVsStringMap interface that represents the strings to write.

Returns

Int32

Returns S_OK if the strings were written or E_ACCESSDENIED if fOverwriteExisting is false and the data object already contains a map by this name.

Remarks

The interface passed in pObject must support SetData for storage medium type TYMED_HGLOBAL, NULL target device, and aspect DVASPECT_CONTENT.

Applies to

Share via