IVsSccProject2.GetSccSpecialFiles Method

Article
10/26/2012

This method is called to discover special (hidden files) associated with 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 GetSccSpecialFiles ( _
    itemid As UInteger, _
    pszSccFile As String, _
    <OutAttribute> pCaStringsOut As CALPOLESTR(), _
    <OutAttribute> pCaFlagsOut As CADWORD() _
) As Integer

'Usage
Dim instance As IVsSccProject2 
Dim itemid As UInteger 
Dim pszSccFile As String 
Dim pCaStringsOut As CALPOLESTR()
Dim pCaFlagsOut As CADWORD()
Dim returnValue As Integer 

returnValue = instance.GetSccSpecialFiles(itemid, _
    pszSccFile, pCaStringsOut, pCaFlagsOut)

int GetSccSpecialFiles(
    uint itemid,
    string pszSccFile,
    CALPOLESTR[] pCaStringsOut,
    CADWORD[] pCaFlagsOut
)

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

function GetSccSpecialFiles(
    itemid : uint, 
    pszSccFile : String, 
    pCaStringsOut : CALPOLESTR[], 
    pCaFlagsOut : CADWORD[]
) : int

Parameters

itemid
Type: System.UInt32

[in] Identifier of the item being queried. Value is taken from the VSITEMIDDWORD.

pszSccFile
Type: System.String

[in] One of the files associated with the node..

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

[out] Special files associated with the file indicated by the pszSccFile value. These are returned in a CALPOLESTR array.

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

[out] Flags whose values are taken from the CADWORD structure.

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

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

This method is called to discover any special or hidden files associated with an item in the project hierarchy. It is called when GetSccFiles returns with the SFF_HasSpecialFiles flag set for any of the files associated with the node.

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