Partilhar via


Função SccGetUserOption

Esta função recupera uma variedade de opções específicas do usuário.

Sintaxe

SCCRTN SccGetUserOption(
   LPVOID pContext,
   LONG nOption,
   LPLONG lpVal
);

Parâmetros

pContext

[em] O ponteiro de contexto do plug-in de controle do código-fonte.

nOpção

[em] Opção a recuperar (consulte Comentários para obter opções possíveis).

lpVal

[saiu] Valor associado à opção.

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 opção foi recuperada com êxito.
SCC_E_OPNOTSUPPORTED A opção não é suportada.
SCC_E_NONSPECIFICERROR Ocorreu um erro não especificado.

Comentários

As seguintes opções são suportadas por este comando:

Opção do usuário Descrição
SCC_USEROPT_CHECKOUT_LOCALVER Determina se o usuário deseja fazer check-out da versão local dos arquivos. lpVal é atribuído SCC_USEROPT_COLV_YES (o usuário deseja fazer check-out de arquivos locais) ou SCC_USEROPT_COLV_NO.

Confira também