Função SccCheckout

  • Artigo

Dada uma lista de nomes de arquivo totalmente qualificados, essa função faz check-out deles para a unidade local. O comentário se aplica a todos os arquivos que estão sendo submetidos a check-out. O argumento de comentário pode ser uma cadeia de null caracteres.

Sintaxe

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

Parâmetros

pvContexto

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

nArquivos

[em] Número de arquivos selecionados para check-out.

lpFileNames

[em] Matriz de nomes de caminho local totalmente qualificados de arquivos a serem submetidos a check-out.

lpComentário

[em] Comentário a ser aplicado a cada um dos arquivos selecionados que estão sendo submetidos a check-out.

fOpções

[em] Sinalizadores de comando (consulte Bitflags usados por comandos específicos).

pvOpções

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

Valor retornado

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 Confira foi um sucesso.
SCC_E_FILENOTCONTROLLED O arquivo selecionado não está sob controle do código-fonte.
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_NOTAUTHORIZED O usuário não tem permissão para executar essa operação.
SCC_E_NONSPECIFICERROR Falha inespecífica. Não foi feito check-out do arquivo.
SCC_E_ALREADYCHECKEDOUT O usuário já tem o arquivo com check-out.
SCC_E_FILEISLOCKED O arquivo está bloqueado, proibindo a criação de novas versões.
SCC_E_FILEOUTEXCLUSIVE Outro usuário fez um checkout exclusivo neste arquivo.
SCC_I_OPERATIONCANCELED A operação foi cancelada antes da conclusão.

Confira também