Partilhar via


Função SccRename

Esta função renomeia um arquivo no sistema de controle de origem.

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

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.

  • lpFileName
    [in] O nome de arquivo totalmente qualificado do arquivo que está sendo renomeado.

  • lpNewName
    [in] 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

A implementação de plug-in de controle de origem dessa função deve retornar 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 estiver aberto sob controle de origem.

SCC_E_FILENOTCONTROLLED

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

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 está autorizado para concluir esta operação.

SCC_E_COULDNOTCREATEPROJECT

Não foi possível criar o projeto como parte do processo de renomeação.

SCC_E_OPNOTPERFORMED

A operação não foi executada.

SCC_E_NONSPECIFICERROR

Ocorreu um erro não especificado ou geral.

Comentários

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

Consulte também

Conceitos

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