Share via

IVSSEvents.BeforeCheckout Method 

  • Article

An event that is fired before a file is checked out from the SourceSafe database.

Namespace: Microsoft.VisualStudio.SourceSafe.Interop
Assembly: Microsoft.VisualStudio.SourceSafe.Interop (in microsoft.visualstudio.sourcesafe.interop.dll)

Syntax

'Declaration
Function BeforeCheckout ( _
    <InAttribute> pIItem As VSSItem, _
    <InAttribute> Local As String, _
    <InAttribute> Comment As String _
) As Boolean
'Usage
Dim instance As IVSSEvents
Dim pIItem As VSSItem
Dim Local As String
Dim Comment As String
Dim returnValue As Boolean

returnValue = instance.BeforeCheckout(pIItem, Local, Comment)

bool BeforeCheckout (
    [InAttribute] VSSItem pIItem,
    [InAttribute] string Local,
    [InAttribute] string Comment
)

bool BeforeCheckout (
    [InAttribute] VSSItem^ pIItem, 
    [InAttribute] String^ Local, 
    [InAttribute] String^ Comment
)

boolean BeforeCheckout (
    /** @attribute InAttribute() */ VSSItem pIItem, 
    /** @attribute InAttribute() */ String Local, 
    /** @attribute InAttribute() */ String Comment
)

function BeforeCheckout (
    pIItem : VSSItem, 
    Local : String, 
    Comment : String
) : boolean

Parameters

  • pIItem
    A reference of the IVSSItem type to an object representing a checked out file.
  • Local
    A string representing a fully qualified path to the local copy of a checked out file.
  • Comment
    Optional. A string containing a comment. The default is an empty string.

Remarks

[IDL]

HRESULT BeforeCheckout ([in]IVSSItem *pIItem, [in] BSTR Local, [out,retval]boolean *pbContinue);

See Also

Reference

IVSSEvents Interface
IVSSEvents Members
Microsoft.VisualStudio.SourceSafe.Interop Namespace