Função SccRemove

Artigo
01/13/2024

Esta função exclui arquivos do sistema de controle do código-fonte.

Sintaxe

SCCRTN SccRemove(
   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 especificados na lpFileNames matriz.

lpFileNames

[em] Matriz de nomes de caminho local totalmente qualificados de arquivos a serem removidos.

lpComentário

[em] O comentário a ser aplicado a cada arquivo que está sendo removido.

fOpções

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

pvOpções

[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	A remoção foi bem-sucedida.
SCC_E_FILENOTCONTROLLED	O arquivo selecionado 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_ISCHECKEDOUT	Não é possível remover um arquivo porque um usuário fez check-out no momento.
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.
SCC_E_NOTAUTHORIZED	O usuário não tem permissão para executar essa operação.
SCC_E_NONSPECIFICERROR	Falha inespecífica; arquivo não foi removido.
SCC_I_OPERATIONCANCELED	A operação foi cancelada antes da conclusão.

Comentários

Essa função remove os arquivos do sistema de controle do código-fonte, mas não os exclui do disco rígido local do usuário.

Confira também

Funções de API do plug-in de controle do código-fonte

Partilhar via