Função SccDirQueryInfo
Essa função examina uma lista de diretórios totalmente qualificados para seu status atual.
Sintaxe
SCCRTN SccDirQueryInfo(
LPVOID pContext,
LONG nDirs,
LPCSTR* lpDirNames,
LPLONG lpStatus
);
Parâmetros
pContext
[em] A estrutura de contexto do plug-in de controle do código-fonte.
nDirs
[em] O número de diretórios selecionados para consulta.
lpDirNomes
[em] Uma matriz de caminhos totalmente qualificados dos diretórios a serem consultados.
lpStatus
[dentro, fora] Uma estrutura de matriz para o plug-in de controle do código-fonte para retornar os sinalizadores de status (consulte Código de status do diretório para obter detalhes).
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 consulta foi bem-sucedida. |
| 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_NONSPECIFICERROR SCC_E_UNKNOWNERROR |
Falha inespecífica. |
Comentários
A função preenche a matriz de retorno com uma máscara de bits da família (consulte Código de status do SCC_DIRSTATUS diretório), uma entrada para cada diretório fornecido. A matriz de status é alocada pelo chamador.
O IDE usa essa função antes que um diretório seja renomeado para verificar se o diretório está sob controle do código-fonte, consultando se ele tem um projeto correspondente. Se o diretório não estiver sob controle do código-fonte, o IDE poderá fornecer o aviso adequado ao usuário.
Observação
Se um plug-in de controle de origem optar por não implementar um ou mais dos valores de status, os bits não implementados deverão ser definidos como zero.