IVsSccProject2.GetSccFiles Method

Article
07/12/2014

This method is called to determine which files should be placed under source control for a given VSITEMID within this hierarchy.

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

Syntax

'Declaration
Function GetSccFiles ( _
    itemid As UInteger, _
    <OutAttribute> pCaStringsOut As CALPOLESTR(), _
    <OutAttribute> pCaFlagsOut As CADWORD() _
) As Integer

int GetSccFiles(
    uint itemid,
    CALPOLESTR[] pCaStringsOut,
    CADWORD[] pCaFlagsOut
)

int GetSccFiles(
    [InAttribute] unsigned int itemid, 
    [OutAttribute] array<CALPOLESTR>^ pCaStringsOut, 
    [OutAttribute] array<CADWORD>^ pCaFlagsOut
)

abstract GetSccFiles : 
        itemid:uint32 * 
        pCaStringsOut:CALPOLESTR[] byref * 
        pCaFlagsOut:CADWORD[] byref -> int

function GetSccFiles(
    itemid : uint, 
    pCaStringsOut : CALPOLESTR[], 
    pCaFlagsOut : CADWORD[]
) : int

Parameters

itemid
Type: System.UInt32

[in] Identifier for the VSITEMID being queried.

pCaStringsOut
Type: array<Microsoft.VisualStudio.OLE.Interop.CALPOLESTR[]

[out] Pointer to an array of CALPOLESTR strings containing the file names for this item.

pCaFlagsOut
Type: array<Microsoft.VisualStudio.OLE.Interop.CADWORD[]

[out] Pointer to a CADWORD array of flags stored in DWORDs indicating that some of the files have special behaviors.

Return Value

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

Note

If a project returns E_NOTIMPL, GetMkDocument will be called to discover the file associated with the node. If each of a project's nodes refers to a single file, and there are no special files, then a project can safely always return E_NOTIMPL.

Remarks

COM Signature

From ivssccproject2.idl

HRESULT GetSccFiles(
   [in] VSITEMID itemid,
   [out] CALPOLESTR *pCaStringsOut,
   [out] CADWORD *pCaFlagsOut
);

If you use GetMkDocument, the flags are assumed to be zero. If pCaFlagsOut->cElems has zero elements, the flags are assumed to be zero. If you do not have any files under source control, zero files should be returned because GetSccFiles serves no other purpose.

If the flag SFF_HasSpecialFiles is set for any of the files associated with the node, GetSccSpecialFiles will be called for those files.

The source file flags (SFF) have two settings:

SFF_NoFlags = 0 indicates that there are no special files associated with the node.
SFF_HasSpecialFiles = 1 (or nonzero) indicates that there are special files associated with the node.

Special files are hidden files that underlie the normal files visible in Solution Explorer and in the Check In and Check Out dialog boxes.

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