IVsSccManager2.GetSccGlyphFromStatus Method

Article
07/12/2014

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

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

Syntax

'Declaration
Function GetSccGlyphFromStatus ( _
    dwSccStatus As UInteger, _
    <OutAttribute> psiGlyph As VsStateIcon() _
) As Integer

int GetSccGlyphFromStatus(
    uint dwSccStatus,
    VsStateIcon[] psiGlyph
)

int GetSccGlyphFromStatus(
    [InAttribute] unsigned int dwSccStatus, 
    [OutAttribute] array<VsStateIcon>^ psiGlyph
)

abstract GetSccGlyphFromStatus : 
        dwSccStatus:uint32 * 
        psiGlyph:VsStateIcon[] byref -> int

function GetSccGlyphFromStatus(
    dwSccStatus : uint, 
    psiGlyph : VsStateIcon[]
) : int

Parameters

dwSccStatus
Type: System.UInt32

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

psiGlyph
Type: array<Microsoft.VisualStudio.Shell.Interop.VsStateIcon[]

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

Return Value

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

Note

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.

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

Share via