IVsDataObjectStringMapManager.WriteStringMap Method

Writes information to a string map.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio (in Microsoft.VisualStudio.dll)
  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
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

  • szStringMapName
    Type: String

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

  • fOverwriteExisting
    Type: Int32

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

Return Value

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

See Also

Reference

IVsDataObjectStringMapManager Interface

Microsoft.VisualStudio.Shell.Interop Namespace