IVsDataObjectStringMapManager.WriteStringMap Method

Writes information to a string map.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

Syntax

'Declaration
Function WriteStringMap ( _
    pObject As IDataObject, _
    szStringMapName As String, _
    fOverwriteExisting As Integer, _
    pStringMap As IVsStringMap _
) As Integer
'Usage
Dim instance As IVsDataObjectStringMapManager
Dim pObject As IDataObject
Dim szStringMapName As String
Dim fOverwriteExisting As Integer
Dim pStringMap As IVsStringMap
Dim returnValue As Integer

returnValue = instance.WriteStringMap(pObject, _
    szStringMapName, fOverwriteExisting, _
    pStringMap)

int WriteStringMap(
    IDataObject pObject,
    string szStringMapName,
    int fOverwriteExisting,
    IVsStringMap pStringMap
)

int WriteStringMap(
    [InAttribute] IDataObject^ pObject, 
    [InAttribute] String^ szStringMapName, 
    [InAttribute] int fOverwriteExisting, 
    [InAttribute] IVsStringMap^ pStringMap
)

abstract WriteStringMap : 
        pObject:IDataObject * 
        szStringMapName:string * 
        fOverwriteExisting:int * 
        pStringMap:IVsStringMap -> int 

function WriteStringMap(
    pObject : IDataObject, 
    szStringMapName : String, 
    fOverwriteExisting : int, 
    pStringMap : IVsStringMap
) : int

Parameters

• pObject
  Type: Microsoft.VisualStudio.OLE.Interop.IDataObject
  [in] An [IDataObject] that contains the string maps.

• szStringMapName
  Type: System.String
  [in] The name of the string map to write.

• fOverwriteExisting
  Type: System.Int32
  [in] Set to true if the new information should overwrite existing information.

• pStringMap
  Type: Microsoft.VisualStudio.Shell.Interop.IVsStringMap
  [in] An [IVsStringMap] interface that represents the strings to write.

Return Value

Type: System.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.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsDataObjectStringMapManager Interface

IVsDataObjectStringMapManager Members

Microsoft.VisualStudio.Shell.Interop Namespace