IVsProject3.AddItemWithSpecific Method

Article
10/26/2012

Adds an item using a specific editor.

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

Syntax

'Declaration
Function AddItemWithSpecific ( _
    itemidLoc As UInteger, _
    dwAddItemOperation As VSADDITEMOPERATION, _
    pszItemName As String, _
    cFilesToOpen As UInteger, _
    rgpszFilesToOpen As String(), _
    hwndDlgOwner As IntPtr, _
    grfEditorFlags As UInteger, _
    ByRef rguidEditorType As Guid, _
    pszPhysicalView As String, _
    ByRef rguidLogicalView As Guid, _
    <OutAttribute> pResult As VSADDRESULT() _
) As Integer

'Usage
Dim instance As IVsProject3 
Dim itemidLoc As UInteger 
Dim dwAddItemOperation As VSADDITEMOPERATION 
Dim pszItemName As String 
Dim cFilesToOpen As UInteger 
Dim rgpszFilesToOpen As String()
Dim hwndDlgOwner As IntPtr 
Dim grfEditorFlags As UInteger 
Dim rguidEditorType As Guid 
Dim pszPhysicalView As String 
Dim rguidLogicalView As Guid 
Dim pResult As VSADDRESULT()
Dim returnValue As Integer 

returnValue = instance.AddItemWithSpecific(itemidLoc, _
    dwAddItemOperation, pszItemName, _
    cFilesToOpen, rgpszFilesToOpen, _
    hwndDlgOwner, grfEditorFlags, rguidEditorType, _
    pszPhysicalView, rguidLogicalView, _
    pResult)

int AddItemWithSpecific(
    uint itemidLoc,
    VSADDITEMOPERATION dwAddItemOperation,
    string pszItemName,
    uint cFilesToOpen,
    string[] rgpszFilesToOpen,
    IntPtr hwndDlgOwner,
    uint grfEditorFlags,
    ref Guid rguidEditorType,
    string pszPhysicalView,
    ref Guid rguidLogicalView,
    VSADDRESULT[] pResult
)

int AddItemWithSpecific(
    [InAttribute] unsigned int itemidLoc, 
    [InAttribute] VSADDITEMOPERATION dwAddItemOperation, 
    [InAttribute] String^ pszItemName, 
    [InAttribute] unsigned int cFilesToOpen, 
    [InAttribute] array<String^>^ rgpszFilesToOpen, 
    [InAttribute] IntPtr hwndDlgOwner, 
    [InAttribute] unsigned int grfEditorFlags, 
    [InAttribute] Guid% rguidEditorType, 
    [InAttribute] String^ pszPhysicalView, 
    [InAttribute] Guid% rguidLogicalView, 
    [OutAttribute] array<VSADDRESULT>^ pResult
)

function AddItemWithSpecific(
    itemidLoc : uint, 
    dwAddItemOperation : VSADDITEMOPERATION, 
    pszItemName : String, 
    cFilesToOpen : uint, 
    rgpszFilesToOpen : String[], 
    hwndDlgOwner : IntPtr, 
    grfEditorFlags : uint, 
    rguidEditorType : Guid, 
    pszPhysicalView : String, 
    rguidLogicalView : Guid, 
    pResult : VSADDRESULT[]
) : int

Parameters

itemidLoc
Type: System.UInt32

[in] Item identifier of the item to add. Values are taken from the VSITEMIDDWORD.

dwAddItemOperation
Type: Microsoft.VisualStudio.Shell.Interop.VSADDITEMOPERATION

[in] Values taken from the VSADDITEMOPERATION enumeration.

pszItemName
Type: System.String

[in] Name of the item to be added.

cFilesToOpen
Type: System.UInt32

[in] Number of files to open.

rgpszFilesToOpen
Type: array<System.String[]

[in, size_is(cFilesToOpen)] Actual number of files passed in with cFilesToOpen.

hwndDlgOwner
Type: System.IntPtr

[in] Handle to the dialog box.

grfEditorFlags
Type: System.UInt32

[in] Flags whose values are taken from the __VSSPECIFICEDITORFLAGS enumeration.

rguidEditorType
Type: System.Guid%

[in] Unique identifier of the editor type.

pszPhysicalView
Type: System.String

[in] Name of physical view.

rguidLogicalView
Type: System.Guid%

[in] Name of the logical view.

pResult
Type: array<Microsoft.VisualStudio.Shell.Interop.VSADDRESULT[]

[out, retval] Results whose values are taken from the VSADDRESULT enumeration.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsProject3::AddItemWithSpecific(
   [in] VSITEMID itemidLoc,
   [in] VSADDITEMOPERATION dwAddItemOperation,
   [in] LPCOLESTR pszItemName,
   [in] ULONG cFilesToOpen,
   [in, size_is(cFilesToOpen)] LPCOLESTR rgpszFilesToOpen[],
   [in] HWND hwndDlgOwner,
   [in] VSSPECIFICEDITORFLAGS grfEditorFlags,
   [in] REFGUID rguidEditorType,
   [in] LPCOLESTR pszPhysicalView,
   [in] REFGUID rguidLogicalView,
   [out, retval] VSADDRESULT *pResult
);

This method is used to add item(s) to the project and additionally to ask the project to open the item using the specified editor information. It is an extension of AddItem.

Implemented in conjunction with OpenSpecificEditor.

.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.

Share via