Função SccQueryInfo

  • Artigo

Essa função obtém informações de status para um conjunto de arquivos selecionados sob controle do código-fonte.

Sintaxe

SCCRTN SccQueryInfo(
   LPVOID  pvContext,
   LONG    nFiles,
   LPCSTR* lpFileNames,
   LPLONG  lpStatus
);

Parâmetros

pvContexto

[em] A estrutura de contexto do plug-in de controle do código-fonte.

nArquivos

[em] Número de arquivos especificados na lpFileNames matriz e o comprimento da lpStatus matriz.

lpFileNames

[em] Uma matriz de nomes de arquivos a serem consultados.

lpStatus

[dentro, fora] Uma matriz na qual o plug-in de controle do código-fonte retorna os sinalizadores de status para cada arquivo. Para obter mais informações, consulte Código de status do arquivo.

Valor de retorno

Espera-se que a implementação do plug-in de controle do código-fonte dessa função retorne um dos seguintes valores:

Valor Descrição
SCC_OK A consulta foi bem-sucedida.
SCC_E_ACCESSFAILURE Houve um problema com o acesso ao sistema de controle do código-fonte, provavelmente causado por problemas de rede ou contenção. Recomenda-se uma nova tentativa.
SCC_E_PROJNOTOPEN O projeto não está aberto sob controle do código-fonte.
SCC_E_NONSPECIFICERROR Falha inespecífica.

Comentários

Se lpFileName for uma cadeia de caracteres vazia, não há informações de status a serem atualizadas no momento. Caso contrário, é o nome do caminho completo do arquivo para o qual as informações de status podem ter sido alteradas.

A matriz de retorno pode ser uma máscara de bits de SCC_STATUS_xxxx bits. Para obter mais informações, consulte Código de status do arquivo. Um sistema de controle do código-fonte pode não oferecer suporte a todos os tipos de bits. Por exemplo, se SCC_STATUS_OUTOFDATE não for oferecido, o bit simplesmente não será definido.

Ao usar essa função para fazer check-out de arquivos, observe os seguintes MSSCCI requisitos de status:

  • SCC_STATUS_OUTBYUSER é definido quando o usuário atual fez check-out do arquivo.

  • SCC_STATUS_CHECKEDOUT não pode ser definido, a menos que SCC_STATUS_OUTBYUSER esteja definido.

  • SCC_STATUS_CHECKEDOUT só é definido quando o arquivo é retirado para o diretório de trabalho designado.

  • Se o arquivo for submetido a check-out pelo usuário atual em um diretório diferente do diretório de trabalho, ele será definido, SCC_STATUS_OUTBYUSER mas SCC_STATUS_CHECKEDOUT não está.

Confira também