IVsTrackProjectDocumentsEvents3.HandsOnFiles Method

  • Article

Called when a project has completed operations on a set of files.

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

Syntax

'Declaration
Function HandsOnFiles ( _
    cFiles As Integer, _
    rgpszMkDocuments As String() _
) As Integer

int HandsOnFiles(
    int cFiles,
    string[] rgpszMkDocuments
)

int HandsOnFiles(
    [InAttribute] int cFiles, 
    [InAttribute] array<String^>^ rgpszMkDocuments
)

abstract HandsOnFiles : 
        cFiles:int * 
        rgpszMkDocuments:string[] -> int 

function HandsOnFiles(
    cFiles : int, 
    rgpszMkDocuments : String[]
) : int

Parameters

  • cFiles
    Type: System.Int32
    [in] Number of file names given in the rgpszMkDocuments array.
  • rgpszMkDocuments
    Type: array<System.String[]
    [in] An array of file names.

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

HRESULT HandsOnFiles(
   [in] int cFiles,
   [in, size_is(cFiles)] const LPCOLESTR rgpszMkDocuments[]
);

This method is called as a result of a call to the HandsOnFiles method.

A project calls the HandsOffFiles method, which results in a call to the HandsOffFiles method. That call is the project telling all implementers of HandsOffFiles to release all requested locks on the specified files.

When the project is done with its processing of the files, it calls the HandsOnFiles method, which in turn calls the HandsOnFiles method, usually with the same array of file names as were passed to the HandsOffFiles method. This allows the implementer of the HandsOffFiles method to reestablish any locks it needs to on the files.

Note

It is possible that some or all of the file names in the array may have been renamed, moved, or deleted.

.NET Framework Security

See Also

Reference

IVsTrackProjectDocumentsEvents3 Interface

Microsoft.VisualStudio.Shell.Interop Namespace