IVsExternalFilesManager2.AddDocument(UInt32, String, IntPtr, IntPtr, Guid, String, Guid, String, String, Int32, IVsWindowFrame) Methode

Definition

Teilt programmgesteuert dem Projekt "Sonstige Dateien" mit, einen Knoten hinzuzufügen.

public:
 int AddDocument(System::UInt32 dwCDW, System::String ^ pszMkDocument, IntPtr punkDocView, IntPtr punkDocData, Guid % rguidEditorType, System::String ^ pszPhysicalView, Guid % rguidCmdUI, System::String ^ pszOwnerCaption, System::String ^ pszEditorCaption, [Runtime::InteropServices::Out] int % pfDefaultPosition, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ % ppWindowFrame);
public int AddDocument (uint dwCDW, string pszMkDocument, IntPtr punkDocView, IntPtr punkDocData, ref Guid rguidEditorType, string pszPhysicalView, ref Guid rguidCmdUI, string pszOwnerCaption, string pszEditorCaption, out int pfDefaultPosition, out Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame ppWindowFrame);
abstract member AddDocument : uint32 * string * nativeint * nativeint * Guid * string * Guid * string * string * int * IVsWindowFrame -> int
Public Function AddDocument (dwCDW As UInteger, pszMkDocument As String, punkDocView As IntPtr, punkDocData As IntPtr, ByRef rguidEditorType As Guid, pszPhysicalView As String, ByRef rguidCmdUI As Guid, pszOwnerCaption As String, pszEditorCaption As String, ByRef pfDefaultPosition As Integer, ByRef ppWindowFrame As IVsWindowFrame) As Integer

Parameter

dwCDW
UInt32

[in] Definiert die __VSCREATEDOCWIN-Flags, die bestimmen, wie das Dokumentfenster erstellt wird.

pszMkDocument
String

[in] Pfad zum Dokument. Die Umgebung verwendet diesen Pfad, um die Ansicht in der aktiven Dokumenttabelle (RDT) zu registrieren.

punkDocView
IntPtr

[in] Zeiger auf die IUnknown-Schnittstelle für das Dokumentenansichtsobjekt, das im Dokumentfenster angezeigt werden soll.

punkDocData
IntPtr

[in] Zeiger auf die IUnknown-Schnittstelle eines Objekts, das das Dokumentendatenobjekt des Dokuments darstellt, das in Situationen hinzugefügt wird, in denen eine Ansichts- oder Datentrennung gegeben ist. Der Kerntext-Editor verfügt beispielsweise über ein Textansichtsobjekt (Objekt VsTextView) und das Textpufferobjekt (Objekt VsTextBuffer). Dieser Parameter kann null sein. Das übergeben null bewirkt, dass die Umgebung eine Instanz einer Standard Implementierung der punkDocData im Namen des Aufrufers erstellt.

rguidEditorType
Guid

[in] Eindeutiger Bezeichner der Editorfactory, die eine Instanz der Dokumentenansichts- und Dokumentendatenobjekte erstellt hat. Dies sollte GUID_NULL sein, wenn das Dokument nicht mit einer Editorfactory erstellt wird (das heißt, dass eine Instanz unter Verwendung von nicht öffentlichen Daten eines bestimmten Projekts erstellt wird).

pszPhysicalView
String

[in] Zeichenfolge, die den physischen Ansichtstyps für den Editor identifiziert.

rguidCmdUI
Guid

[in] Gibt die GUID an, die angibt, welche Gruppe von Menüs in die Hauptmenüleiste aufgenommen werden soll, wenn dieses Dokument aktiv ist. Es wird zum Aktivieren der Sichtbarkeit von Befehlen und Toolfenstern verwendet.

pszOwnerCaption
String

[in] Ursprüngliche Beschriftung, definiert vom Dokumentbesitzer (d. h. vom Projekt) für das Dokumentfenster. Dabei wird häufig das folgende Format verwendet: "Projektname – Elementname".

pszEditorCaption
String

[in] Ursprüngliche Beschriftung, definiert vom Dokument-Editor für das Dokumentfenster. Dies ist normalerweise eine Zeichenfolge, die in eckigen Klammern steht (beispielsweise [Read Only]). Der Anfangswert dieses Parameters wird als [out]-Parameter in der CreateEditorInstance(UInt32, String, String, IVsHierarchy, UInt32, IntPtr, IntPtr, IntPtr, String, Guid, Int32)-Methode zurückgegeben.

pfDefaultPosition
Int32

[out] Kann null sein, wenn der Aufrufer nicht die Standardpositionsinformationen für das Fenster möchte. true Wenn in der Umgebung keine Informationen über die letzte Position dieses Tool Fensters gespeichert wurden (das heißt, guidPersistenceSlot wurde nicht gefunden), wurde sie an einem Standard Speicherort auf dem Bildschirm platziert. false, wenn dieses Fenster dort platziert wurde, wo der Benutzer es zuletzt gefunden und vergrößert oder verkleinert hat.

ppWindowFrame
IVsWindowFrame

[out] Zeiger auf den Frame, der diesen Editor enthält, der verwendet werden kann, um den Speicherort, die Größe, die Beschriftung und andere Eigenschaften des Fensters zu ändern. Sie kann auch verwendet werden, um den IUnknown Schnittstellen Zeiger der Einbettung (d punkDocView . h. oder) zu erhalten punkDocData .

Gibt zurück

Int32

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.

Implementiert

Hinweise

COM-Signatur

Aus vsshell. idl:

HRESULT IVsExternalFilesManager2::AddDocument(  
   [in] VSCREATEDOCWIN dwCDW,  
   [in] LPCOLESTR pszMkDocument,  
   [in] IUnknown *punkDocView,  
   [in] IUnknown *punkDocData,  
   [in] REFGUID rguidEditorType,  
   [in] LPCOLESTR pszPhysicalView,  
   [in] REFGUID rguidCmdUI,  
   [in] LPCOLESTR pszOwnerCaption,  
   [in] LPCOLESTR pszEditorCaption,  
   [out] BOOL *pfDefaultPosition,  
   [out] IVsWindowFrame **ppWindowFrame  
);  

Ähnelt der- CreateDocumentWindow Methode. AddDocument schließt die Parameter ItemId und pUIH (einen Zeiger auf) nicht IVsHierarchy ein, da das Projekt "sonstige Dateien" das eigene ItemId und das Paar zuweist pUIH und den Rest der Parameter verwendet, AddDocument um ein Dokument Fenster zu erstellen.

Gilt für