Função SccAdd

Artigo
01/13/2024

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

Sintaxe

SCCRTN SccAdd(
   LPVOID    pvContext,
   HWND      hWnd,
   LONG      nFiles,
   LPCSTR*   lpFileNames,
   LPCSTR    lpComment,
   LONG*     pfOptions,
   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 serem adicionados ao projeto atual, conforme indicado na lpFileNames matriz.

lpFileNames

[em] Matriz de nomes locais totalmente qualificados de arquivos a serem adicionados.

lpComentário

[em] O comentário a ser aplicado a todos os arquivos que estão sendo adicionados.

pfOpções

[em] Matriz de sinalizadores de comando, fornecida por arquivo.

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	A operação de adição foi bem-sucedida.
SCC_E_FILEALREADYEXISTS	O arquivo selecionado já está sob controle do código-fonte.
SCC_E_TYPENOTSUPPORTED	O tipo do arquivo (por exemplo, binário) não é suportado pelo sistema de 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_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; adição não executada.
SCC_I_OPERATIONCANCELED	A operação foi cancelada antes da conclusão.
SCC_I_RELOADFILE	Um arquivo ou projeto precisa ser recarregado.
SCC_E_FILENOTEXIST	O arquivo local não foi encontrado.

Comentários

Os usuais fOptions são substituídos aqui por uma matriz, pfOptions, com uma LONG especificação de opção por arquivo. Isso ocorre porque o tipo de arquivo pode variar de arquivo para arquivo.

Observação

É inválido especificar ambas e SCC_FILETYPE_TEXT SCC_FILETYPE_BINARY opções para o mesmo arquivo, mas é válido não especificar nenhuma delas. Não definir nenhum dos dois é o mesmo que definir SCC_FILETYPE_AUTO, caso em que o plug-in de controle do código-fonte detecta automaticamente o tipo de arquivo.

Abaixo está a lista de sinalizadores usados na pfOptions matriz:

Opção	Valor	Significado
SCC_FILETYPE_AUTO	0x00	O plug-in de controle do código-fonte deve detectar o tipo de arquivo.
SCC_FILETYPE_TEXT	0x01	Indica um arquivo de texto ASCII.
SCC_FILETYPE_BINARY	0x02	Indica um tipo de arquivo diferente do texto ASCII.
SCC_ADD_STORELATEST	0x04	Armazena apenas a cópia mais recente do arquivo, sem deltas.
SCC_FILETYPE_TEXT_ANSI	0x08	Trata o arquivo como texto ANSI.
SCC_FILETYPE_UTF8	0x10	Trata o arquivo como texto Unicode no formato UTF8.
SCC_FILETYPE_UTF16LE	0x20	Trata o arquivo como texto Unicode no formato UTF16 Little Endian.
SCC_FILETYPE_UTF16BE	0x40	Trata o arquivo como texto Unicode no formato UTF16 Big Endian.

Confira também

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

Partilhar via