Função SccHistory

  • Artigo

Essa função exibe o histórico dos arquivos especificados.

Sintaxe

SCCRTN SccHistory(
   LPVOID    pvContext,
   HWND      hWnd,
   LONG      nFiles,
   LPCSTR*   lpFileNames,
   LONG      fOptions,
   LPCMDOPTS pvOptions
);

Parâmetros

pvContext

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

hWnd

[em] Um identificador para a janela do IDE que o plug-in de controle do código-fonte pode usar como pai para quaisquer caixas de diálogo que ele forneça.

nFiles

[em] Número de arquivos especificados na lpFileName matriz.

lpFileName

[em] Matriz de nomes totalmente qualificados de arquivos.

fOptions

[em] Sinalizadores de comando (atualmente não usados).

pvOptions

[em] Opções específicas do plug-in de controle do código-fonte.

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 O histórico de versões foi obtido com sucesso.
SCC_I_RELOADFILE O sistema de controle do código-fonte realmente modificou o arquivo no disco enquanto buscava o histórico (por exemplo, obtendo uma versão antiga dele), então o IDE deve recarregar esse arquivo.
SCC_E_FILENOTCONTROLLED O arquivo não está sob controle do código-fonte.
SCC_E_OPNOTSUPPORTED O sistema de controle do código-fonte não oferece suporte a essa operação.
SCC_E_NOTAUTHORIZED O usuário não tem permissão para executar essa operação.
SCC_E_ACCESSFAILURE Houve um problema ao acessar o sistema de controle do código-fonte, provavelmente devido a problemas de rede ou contenção. Recomenda-se uma nova tentativa.
SCC_E_PROJNOTOPEN O projeto ainda não foi aberto.
SCC_E_NONSPECIFICERROR Falha inespecífica. Não foi possível obter o histórico de arquivos.

Comentários

O plug-in de controle do código-fonte pode exibir sua própria caixa de diálogo para mostrar o histórico de cada arquivo, usando hWnd como a janela pai. Como alternativa, a função de retorno de chamada de saída de texto opcional fornecida ao SccOpenProject pode ser usada, se for suportada.

Observe que, em determinadas circunstâncias, o arquivo que está sendo examinado pode mudar durante a execução desta chamada. Por exemplo, o comando de histórico do Visual SourceSafe dá ao usuário a chance de obter uma versão antiga do arquivo. Nesse caso, o plug-in de controle do código-fonte retorna SCC_I_RELOAD para avisar o IDE de que ele precisa recarregar o arquivo.

Observação

Se o plug-in de controle do código-fonte não oferecer suporte a essa função para uma matriz de arquivos, somente o histórico de arquivos do primeiro arquivo poderá ser exibido.

Confira também