Função SccRename

  • Artigo

Essa função renomeia um arquivo no sistema de controle do código-fonte.

Sintaxe

SCCRTN SccRename(
   LPVOID pvContext,
   HWND   hWnd,
   LPCSTR lpFileName,
   LPCSTR lpNewName
);

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.

lpFileName

[em] O nome de arquivo totalmente qualificado do arquivo que está sendo renomeado.

lpNewName

[em] O novo nome totalmente qualificado. Se o caminho do diretório for diferente, o arquivo foi movido de um subdiretório para outro.

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 operação de renomeação foi concluída com êxito.
SCC_E_PROJNOTOPEN O projeto não está aberto sob controle do código-fonte.
SCC_E_FILENOTCONTROLLED O arquivo 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.
SCC_E_NOTAUTHORIZED O usuário não está autorizado a concluir esta operação.
SCC_E_COULDNOTCREATEPROJECT O projeto não pôde ser criado como parte do processo de renomeação.
SCC_E_OPNOTPERFORMED A operação não foi realizada.
SCC_E_NONSPECIFICERROR Ocorreu um erro geral ou não especificado.

Comentários

Essa função pode ser usada para renomear um arquivo ou movê-lo de um local para outro no sistema de controle do código-fonte. O plug-in de controle do código-fonte não deve tentar acessar o arquivo no disco. É responsabilidade do IDE renomear o arquivo local.

Confira também