IVsSccManager2.GetSccGlyphFromStatus(UInt32, VsStateIcon[]) Method

Definition

This function determines which glyph to display, given a combination of status flags.

public:
 int GetSccGlyphFromStatus(System::UInt32 dwSccStatus, cli::array <Microsoft::VisualStudio::Shell::Interop::VsStateIcon> ^ psiGlyph);
public:
 int GetSccGlyphFromStatus(unsigned int dwSccStatus, Platform::Array <Microsoft::VisualStudio::Shell::Interop::VsStateIcon> ^ psiGlyph);
int GetSccGlyphFromStatus(unsigned int dwSccStatus, std::Array <Microsoft::VisualStudio::Shell::Interop::VsStateIcon> const & psiGlyph);
public int GetSccGlyphFromStatus (uint dwSccStatus, Microsoft.VisualStudio.Shell.Interop.VsStateIcon[] psiGlyph);
abstract member GetSccGlyphFromStatus : uint32 * Microsoft.VisualStudio.Shell.Interop.VsStateIcon[] -> int
Public Function GetSccGlyphFromStatus (dwSccStatus As UInteger, psiGlyph As VsStateIcon()) As Integer

Parameters

dwSccStatus
UInt32

[in] A combination of flags from the SccStatus enumeration. For a list of possible values, see File Status Code Enumerator.

psiGlyph
VsStateIcon[]

[out] Returns the icon to display as a value from the VsStateIcon enumeration.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.If this method returns S_OK, it must set psiGlyph to a VsStateIcon value other than STATEICON_NOSTATEICON (which is always considered an invalid icon index).

Remarks

COM Signature

From ivssccmanager2.idl

HRESULT GetSccGlyphFromStatus(  
   [in] DWORD dwSccStatus,  
   [out, retval] VsStateIcon *psiGlyph  
);  

Projects should not cache source control status for files in order to use this method on a regular basis. Instead, a project should use the GetSccGlyph method at the time the glyph is needed.

Applies to