Partilhar via


Função SccRemove

Esta função exclui os arquivos do sistema de controle de origem.

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

Parâmetros

  • pvContext
    [in] A estrutura de contexto de plug-in de controle de origem.

  • hWnd
    [in] Um identificador para a janela do IDE que o plug-in de controle de origem pode usar como um pai para as caixas de diálogo que ele fornece.

  • nFiles
    [in] Número de arquivos especificados no lpFileNames array.

  • lpFileNames
    [in] Matriz de nomes de caminho local totalmente qualificado de arquivos a serem removidos.

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

  • fOptions
    [in] Sinalizadores de comando (não usadas).

  • pvOptions
    [in] Opções de plug-in específico de controle de origem.

Valor de retorno

A implementação de plug-in de controle de origem dessa função deve retornar um dos seguintes valores:

Valor

Descrição

SCC_OK

Remoção foi bem-sucedida.

SCC_E_FILENOTCONTROLLED

O arquivo selecionado não está sob controle de origem.

SCC_E_OPNOTSUPPORTED

O sistema de controle de origem não oferece suporte para esta operação.

SCC_E_ISCHECKEDOUT

Não é possível remover um arquivo porque um usuário tiver feito check-out no momento.

SCC_E_ACCESSFAILURE

Houve um problema ao acessar o sistema de controle de origem, provavelmente devido a problemas de rede ou contenção.

SCC_E_NOTAUTHORIZED

O usuário não tem permissão para executar esta operação.

SCC_E_NONSPECIFICERROR

Falha não específica; arquivo não foi removido.

SCC_I_OPERATIONCANCELED

A operação foi cancelada antes da conclusão.

Comentários

Esta função remove os arquivos do sistema de controle de origem, mas não excluí-los da unidade de disco rígido local do usuário.

Consulte também

Conceitos

Funções de API plug-in de controle de origem