Método IVsSccManager2.GetSccGlyph (Int32, String[], VsStateIcon[], UInt32 )

Artigo
04/23/2016

Este método é chamado por projetos para descobrir os glifos de controle de origem para usar em arquivos e o status dos arquivos de controle de origem; Isso é a única maneira de obter status.

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

Sintaxe

int GetSccGlyph(
    int cFiles,
    string[] rgpszFullPaths,
    VsStateIcon[] rgsiGlyphs,
    uint[] rgdwSccStatus
)

int GetSccGlyph(
    int cFiles,
    array<String^>^ rgpszFullPaths,
    array<VsStateIcon>^ rgsiGlyphs,
    array<unsigned int>^ rgdwSccStatus
)

abstract GetSccGlyph : 
        cFiles:int *
        rgpszFullPaths:string[] *
        rgsiGlyphs:VsStateIcon[] *
        rgdwSccStatus:uint32[] -> int

Function GetSccGlyph (
    cFiles As Integer,
    rgpszFullPaths As String(),
    rgsiGlyphs As VsStateIcon(),
    rgdwSccStatus As UInteger()
) As Integer

Parâmetros

cFiles
[in] Contagem de arquivos.Ele deve ser maior que 0, se houver arquivos sob controle de código-fonte.Atualmente, o ambiente aceita apenas uma contagem de 1.

rgpszFullPaths
[in] Matriz de caminhos de arquivos. não pode ser null.

rgsiGlyphs
[out] Matriz de ícones correspondentes rgpszFullPaths; não pode ser null.Consulte VsStateIcon para obter informações adicionais.

rgdwSccStatus
[out] Especifica o status de correspondente rgpszFullPaths entrada.Para obter uma lista dos valores possíveis, consulte o enumerador de código de Status do arquivo.Esse parâmetro pode ser null.

Valor de retorno

Type: System.Int32

O método retorna S_OK se pelo menos um dos arquivos é controlado, S_FALSE se nenhum for controlado.

Comentários

COM assinatura

De ivssccmanager2.idl

HRESULT GetSccGlyph(
   [in] int cFiles,
   [in, size_is(cFiles)] const LPCOLESTR rgpszFullPaths[],
   [out, size_is(cFiles)] VsStateIcon rgsiGlyphs[],
   [out, size_is(cFiles)] DWORD rgdwSccStatus[]
);

Este método é chamado por projetos para descobrir os glifos de controle de origem para usar em arquivos.Quando um projeto é aberto pela primeira vez na inicialização, ele chama esse método para obter os glifos para o projeto.Após a inicialização, o ambiente oferece glifos para o projeto usando SccGlyphChanged.Os glifos são indicados por índice do ícone do ambiente (VsStateIcon enumeração).

Como esse método é usado pelos projetos

O status de controle de origem por arquivo como opção, também é retornado; No entanto, os projetos são incentivados a usar os glifos, mas não para o status de controle de origem do cache.Chame esse método, que é necessário o status de cada vez, em vez de manter seu próprio registro de bits de status.

Quando o projeto recebe o GetProperty método (VSHPROPID_StateIconIndex) chamada do ambiente, ele deve chamar GetSccGlyph para o arquivo apropriado ou os arquivos para o VSITEMID especificado na chamada.O projeto não precisa armazenar no ícone estado retornado — o ambiente irá armazená-lo.É importante observar que um projeto pode chamar GetSccGlyph quando chamado pelo ambiente com GetProperty, mas quando ele é chamado SccGlyphChanged, o projeto é entregue os glifos e não precisa chamar GetSccGlyph novamente.O projeto imediatamente pode passar os glifos determinados para o ambiente usando o SetProperty método, a menos que os parâmetros para SccGlyphChanged são null.Nesse caso, o projeto deve chamar o ambiente para todos os VSITEMID s no projeto.

Esteja ciente das seguintes opções:

Se um arquivo estiver sob controle de origem, o SCC_STATUS_CONTROLLED sinalizador estiver definido.
Se o usuário atual faz check-out de um arquivo no diretório de trabalho designado, o SCC_STATUS_CHECKEDOUT sinalizador estiver definido.

Consulte também

Interface IVsSccManager2
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via