SubordinateFileHelper.LockSubordinateDocument Method

Definition

Namespace:

Microsoft.VisualStudio.Modeling.Shell

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

Overloads

LockSubordinateDocument(IServiceProvider, DocData, UInt32)	Creates and returns an invisible editor for the given file.
LockSubordinateDocument(IServiceProvider, DocData, String, UInt32)	Creates and returns an invisible editor for the given file.

LockSubordinateDocument(IServiceProvider, DocData, UInt32)

Important

This API is not CLS-compliant.

Creates and returns an invisible editor for the given file.

public:
 static Microsoft::VisualStudio::Modeling::Shell::SubordinateDocumentLockHolder ^ LockSubordinateDocument(IServiceProvider ^ serviceProvider, Microsoft::VisualStudio::Modeling::Shell::DocData ^ parentDocData, System::UInt32 childItemId);

public static Microsoft.VisualStudio.Modeling.Shell.SubordinateDocumentLockHolder LockSubordinateDocument (IServiceProvider serviceProvider, Microsoft.VisualStudio.Modeling.Shell.DocData parentDocData, uint childItemId);

static member LockSubordinateDocument : IServiceProvider * Microsoft.VisualStudio.Modeling.Shell.DocData * uint32 -> Microsoft.VisualStudio.Modeling.Shell.SubordinateDocumentLockHolder

Public Shared Function LockSubordinateDocument (serviceProvider As IServiceProvider, parentDocData As DocData, childItemId As UInteger) As SubordinateDocumentLockHolder

Parameters

serviceProvider

IServiceProvider

Service provider used to retrieve shell services.

parentDocData

DocData

Parent document.

childItemId

UInt32

Item id identifying child file.

Returns

SubordinateDocumentLockHolder

IVsInvisibleEditor object representing the file in memory.

LockSubordinateDocument(IServiceProvider, DocData, String, UInt32)

Important

This API is not CLS-compliant.

Creates and returns an invisible editor for the given file.

public:
 static Microsoft::VisualStudio::Modeling::Shell::SubordinateDocumentLockHolder ^ LockSubordinateDocument(IServiceProvider ^ serviceProvider, Microsoft::VisualStudio::Modeling::Shell::DocData ^ parentDocData, System::String ^ childFileName, System::UInt32 childItemId);

public static Microsoft.VisualStudio.Modeling.Shell.SubordinateDocumentLockHolder LockSubordinateDocument (IServiceProvider serviceProvider, Microsoft.VisualStudio.Modeling.Shell.DocData parentDocData, string childFileName, uint childItemId);

static member LockSubordinateDocument : IServiceProvider * Microsoft.VisualStudio.Modeling.Shell.DocData * string * uint32 -> Microsoft.VisualStudio.Modeling.Shell.SubordinateDocumentLockHolder

Public Shared Function LockSubordinateDocument (serviceProvider As IServiceProvider, parentDocData As DocData, childFileName As String, childItemId As UInteger) As SubordinateDocumentLockHolder

Parameters

serviceProvider

IServiceProvider

Service provider used to retrieve shell services.

parentDocData

DocData

Parent document.

childFileName

String

File to create the lock holder for.

childItemId

UInt32

Item id identifying subordinate document.

Returns

SubordinateDocumentLockHolder

IVsInvisibleEditor object representing the file in memory.