Share via

IVsDataObjectStringMapManager.ReadStringMap 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.12.40391

Reads the named string map from the specified data object.

public:
 int ReadStringMap(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pObject, System::String ^ szStringMapName, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsStringMap ^ % ppStringMap);
public:
 int ReadStringMap(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pObject, Platform::String ^ szStringMapName, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsStringMap ^ &  ppStringMap);
int ReadStringMap(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pObject, std::wstring const & szStringMapName, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsStringMap const & & ppStringMap);
public int ReadStringMap (Microsoft.VisualStudio.OLE.Interop.IDataObject pObject, string szStringMapName, out Microsoft.VisualStudio.Shell.Interop.IVsStringMap ppStringMap);
abstract member ReadStringMap : Microsoft.VisualStudio.OLE.Interop.IDataObject * string * IVsStringMap -> int
Public Function ReadStringMap (pObject As IDataObject, szStringMapName As String, ByRef ppStringMap As IVsStringMap) As Integer

Parameters

pObject
IDataObject

[in] An IDataObject that contains string maps.

szStringMapName
String

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

ppStringMap
IVsStringMap

[out] The IVsStringMap that was read.

Returns

Int32

Returns S_OK if the string map was read or E_VS_MAPMISSING (0x80042001) if the data object does not contain a string map with the given name.

Applies to