IVsSccProject2.GetSccSpecialFiles Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

This method is called to discover special (hidden files) associated with a given VSITEMID within this hierarchy.

public:
 int GetSccSpecialFiles(System::UInt32 itemid, System::String ^ pszSccFile, cli::array <Microsoft::VisualStudio::OLE::Interop::CALPOLESTR> ^ pCaStringsOut, cli::array <Microsoft::VisualStudio::OLE::Interop::CADWORD> ^ pCaFlagsOut);

int GetSccSpecialFiles(unsigned int itemid, std::wstring const & pszSccFile, std::Array <Microsoft::VisualStudio::OLE::Interop::CALPOLESTR> const & pCaStringsOut, std::Array <Microsoft::VisualStudio::OLE::Interop::CADWORD> const & pCaFlagsOut);

public int GetSccSpecialFiles (uint itemid, string pszSccFile, Microsoft.VisualStudio.OLE.Interop.CALPOLESTR[] pCaStringsOut, Microsoft.VisualStudio.OLE.Interop.CADWORD[] pCaFlagsOut);

abstract member GetSccSpecialFiles : uint32 * string * Microsoft.VisualStudio.OLE.Interop.CALPOLESTR[] * Microsoft.VisualStudio.OLE.Interop.CADWORD[] -> int

Public Function GetSccSpecialFiles (itemid As UInteger, pszSccFile As String, pCaStringsOut As CALPOLESTR(), pCaFlagsOut As CADWORD()) As Integer

Parameters

itemid

UInt32

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

pszSccFile

String

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

pCaStringsOut

CALPOLESTR[]

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

pCaFlagsOut

CADWORD[]

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

Returns

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.