Função SccProperties
Essa função exibe as propriedades de controle do código-fonte para um arquivo ou projeto.
Sintaxe
SCCRTN SccProperties (
LPVOID pvContext,
HWND hWnd,
LPCSTR lpFileName
);
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 do caminho totalmente qualificado do arquivo ou projeto.
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 | As propriedades foram exibidas com êxito. |
| SCC_I_RELOADFILE | O sistema de controle de versão modificou as propriedades do arquivo, portanto, o IDE deve recarregar esse arquivo. |
| SCC_E_PROJNOTOPEN | O projeto especificado não foi aberto no controle do código-fonte. |
| SCC_E_NOTAUTHORIZED | O usuário não está autorizado a exibir propriedades deste arquivo ou projeto. |
| SCC_E_FILENOTCONTROLLED | O arquivo ou projeto especificado não está sob controle do código-fonte. |
| SCC_E_NONSPECIFICERROR SCC_E_UNKNOWNERROR |
Ocorreu um erro desconhecido ou geral. |
Comentários
O plug-in de controle do código-fonte exibe as propriedades em sua própria caixa de diálogo.
As propriedades são definidas pelo plug-in de controle do código-fonte e podem diferir de plug-in para plug-in. Se o plug-in permitir que o usuário altere as propriedades de controle de origem de um arquivo, ele deverá retornar SCC_I_RELOAD para sinalizar ao IDE que esse arquivo ou projeto precisa ser recarregado.