Função SccInitialize
Essa função inicializa o plug-in de controle de origem e fornece recursos e limites para o ambiente de desenvolvimento integrado (IDE).
SCCRTN SccInitialize (
LPVOID* ppvContext,
HWND hWnd,
LPCSTR lpCallerName,
LPSTR lpSccName,
LPLONG lpSccCaps,
LPSTR lpAuxPathLabel,
LPLONG pnCheckoutCommentLen,
LPLONG pnCommentLen
);
Parâmetros
ppvContext
[in] O plug-in de controle de origem pode colocar um ponteiro para a sua estrutura de contexto aqui.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.lpCallerName
[in] O nome do programa chamando o controle de origem plug-in.lpSccName
[in, out] O buffer onde o plug-in de controle de origem coloca o seu próprio nome (não deve exceder SCC_NAME_LEN).lpSccCaps
[out] Retorna o controle de origem sinalizadores de recurso do plug-in.lpAuxPathLabel
[in, out] O buffer onde o plug-in de controle de origem coloca uma seqüência de caracteres que descreve o lpAuxProjPath parâmetro retornado pela Função SccOpenProject e o Função SccGetProjPath (não deve exceder SCC_AUXLABEL_LEN).pnCheckoutCommentLen
[out] Retorna o comprimento máximo permitido para um comentário de check-out.pnCommentLen
[out] Retorna o comprimento máximo permitido para outros comentários.
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 |
Inicialização de controle de origem foi bem-sucedida. |
SCC_E_INITIALIZEFAILED |
Não foi possível inicializar o sistema. |
SCC_E_NOTAUTHORIZED |
O usuário não tem permissão para executar a operação especificada. |
SCC_E_NONSPECFICERROR |
Falha não específica; sistema de controle de origem não foi inicializado. |
Comentários
O IDE chama essa função quando ele carrega o plug-in de controle de origem pela primeira vez. Ele permite que o IDE passar a determinadas informações, como, por exemplo, o nome do chamador, para o plug-in. O IDE também obtém volta determinadas informações como, por exemplo, o comprimento máximo permitido para comentários e recursos do plug-in.
O ppvContext aponta para uma NULL ponteiro. O plug-in de controle de origem pode alocar uma estrutura para uso próprio e armazenar um ponteiro para essa estrutura na ppvContext. O IDE irá passar este ponteiro para todas as outras funções de API VSSCI, permitindo que o plug-in para que a informação de contexto disponível sem recorrer ao armazenamento global e para oferecer suporte a várias instâncias do plug-in. Essa estrutura deve ser desalocada quando a Função SccUninitialize é chamado.
O lpCallerName e lpSccName parâmetros permitem que o IDE e o plug-in de controle de origem para a troca de nomes. Esses nomes podem ser usados simplesmente para distinguir entre várias instâncias ou, na verdade, eles podem aparecer em menus ou caixas de diálogo.
O lpAuxPathLabel parâmetro é uma seqüência de caracteres usada como um comentário para identificar o caminho do projeto auxiliares que é armazenado no arquivo de solução e passado para o controle de origem plug-in em uma chamada para o Função SccOpenProject. Visual SourceSafeusa a seqüência "projeto SourceSafe:"; outros plug-ins de controle de origem devem se abstenha de usar a essa seqüência de caracteres específica.
O lpSccCaps parâmetro dá ao controle de origem plug-in um local para armazenar os sinalizadores de bit indicando os recursos do plug-in. (Para obter uma lista completa dos sinalizadores de bit de recurso, consulte Sinalizadores de recurso). Por exemplo, se os planos de plug-in para gravar resultados em uma função de retorno de chamada fornecido pelo chamador, o plug-in definiria o recurso bit de SCC_CAP_TEXTOUT. Isso seria sinal IDE para criar uma janela de resultados de controle de versão.