SccSetOption (Función)

Artículo
05/18/2015

Esta función establece las opciones que controlan el comportamiento del complemento de control de código fuente.

SCCRTN SccSetOption(
   LPVOID pvContext,
   LONG   nOption,
   LONG   dwVal
);

Parámetros

pvContext
[in] estructura de contexto del complemento de control de código fuente de El.
nOption
[in] opción se establece.
dwVal
[in] valores para la opción.

Valor devuelto

La implementación del complemento de control de código fuente de esta función es esperada devolver uno de los siguientes valores:

Valor	Descripción
SCC_OK	La opción se ha establecido correctamente.
SCC_I_SHARESUBPROJOK	Si se nOptionSCC_OPT_SHARESUBPROJ devuelto y el complemento de control de código fuente permite que el IDE establezca la carpeta de destino.
SCC_E_OPNOTSUPPORTED	La opción no se ha establecido y no se debe confiar sobre.

Comentarios

El IDE llama a esta función para controlar el comportamiento del complemento de control de código fuente. El primer parámetro, nOption, indica el valor se establece que, mientras que el segundo, dwVal, indica qué hacer con ese valor. El complemento almacena esta información asociada con pvContext, para que el IDE debe llamar a esta función después de llamar a SccInitialize (Función) (pero no necesariamente después de cada llamada a SccOpenProject (Función)).

Resumen de las opciones y sus valores:

nOption	dwValue	Descripción
SCC_OPT_EVENTQUEUE	SCC_OPT_EQ_DISABLE SCC_OPT_EQ_ENABLE	Habilita o deshabilita la puesta en cola de eventos del fondo.
SCC_OPT_USERDATA	Valor arbitrario	Especifica un valor de usuario que se va a pasar a la función de devolución de llamada de OPTNAMECHANGEPFN .
SCC_OPT_HASCANCELMODE	SCC_OPT_HCM_NO SCC_OPT_HCM_YES	Indica si el IDE admite actualmente la cancelación de una operación.
SCC_OPT_NAMECHANGEPFN	Puntero a la función de devolución de llamada de OPTNAMECHANGEPFN	Establece un puntero a una función de devolución de llamada de cambio de nombre.
SCC_OPT_SCCCHECKOUTONLY	SCC_OPT_SCO_NO SCC_OPT_SCO_YES	Indica si el IDE permite comprobar fuera de sus archivos manualmente (a través de la interfaz de usuario del control de código fuente) o si deben ser desprotegidos sólo con el complemento de control de código fuente.
SCC_OPT_SHARESUBPROJ	N/D	Si el complemento de control de código fuente permite que el IDE especifique la carpeta local del proyecto, el complemento devuelve SCC_I_SHARESUBPROJOK.

SCC_OPT_EVENTQUEUE

Si nOption es SCC_OPT_EVENTQUEUE, el IDE está deshabilitar (o si se vuelve a habilitar) procesamiento en segundo plano. Por ejemplo, durante una compilación, el IDE puede indicar al complemento de control de código fuente para detener el procesamiento de la en-marcha lento de la clase. Después de la compilación, se volviera a permitir procesamiento en segundo plano conservar la cola del evento de complemento hacia arriba hasta la fecha. Correspondiente al valor de SCC_OPT_EVENTQUEUE de nOption, hay dos valores posibles para dwVal, a saber, SCC_OPT_EQ_ENABLE y SCC_OPT_EQ_DISABLE.

SCC_OPT_HASCANCELMODE

Si el valor de nOption es SCC_OPT_HASCANCELMODE, el IDE permite a los usuarios cancelar operaciones largas. El valor dwVal a SCC_OPT_HCM_NO (valor predeterminado) indica que el IDE no tiene ningún modo de eliminación. El complemento de control de código fuente debe proporcionar su propio botón Cancelar si desea que el usuario pueda cancelar. SCC_OPT_HCM_YES indica que el IDE proporciona la capacidad de cancelar una operación, por lo que el complemento de SCC no necesita generar su propio botón Cancelar. Si el IDE establece dwVal a SCC_OPT_HCM_YES, se prepara para responder a SCC_MSG_STATUS y mensajes de DOCANCEL enviados a la función de devolución de llamada de lpTextOutProc (vea LPTEXTOUTPROC). Si el IDE no establece esta variable, el complemento no debe enviar estos dos mensajes.

SCC_OPT_NAMECHANGEPFN

Si el nOption se establece en SCC_OPT_NAMECHANGEPFN, y el complemento de control de código fuente y el IDE lo permiten, el complemento puede cambiar o mover realmente un archivo durante una operación de control de código fuente. dwVal se establece en un puntero a función de OPTNAMECHANGEPFNescrito. Durante una operación de control de código fuente, el complemento puede llamar a esta función, pasando tres parámetros. Éstos son el nombre anterior (con la ruta de acceso completa) de un archivo, el nuevo nombre (con la ruta de acceso completa) de ese archivo, y puntero a información que tiene importancia al IDE. El IDE envía en este último puntero llamando a SccSetOption con nOption establecido en SCC_OPT_USERDATA, con dwVal apunta a los datos. Compatibilidad para esta función es opcional. Un VSSCI enchufe-que utiliza esta función debe inicializar las variables de los datos de puntero a función y de usuario a NULL, y no debe llamar a una función rename a menos que se haya especificado uno. También debe estar preparado para contener el valor que ha recibido o cambiarlo en respuesta a una nueva llamada a SccSetOption. Esto no sucede en medio de una operación de comando de control de código fuente, pero puede ocurrir entre los comandos.

SCC_OPT_SCCCHECKOUTONLY

Si el nOption se establece en SCC_OPT_SCCCHECKOUTONLY, el IDE está indicando que los archivos del proyecto que está abierto nunca deben desproteger manualmente a través de la interfaz de usuario del sistema de control de código fuente. En su lugar, los archivos se debe desproteger sólo con el complemento de control de código fuente bajo control del IDE. Si dwValue se establece en SCC_OPT_SCO_NO, significa que los archivos se deben tratar normalmente por el complemento y se pueden desproteger con la interfaz de usuario del control de código fuente. Si dwValue se establece en SCC_OPT_SCO_YES, sólo el complemento se permite desproteger los archivos, la interfaz de usuario del sistema de control de código fuente no debe invocarlo. Aquí es en situaciones donde el IDE podría tener “pseudo-archivos” que tienen sentido de desproteger sólo con el IDE.

SCC_OPT_SHARESUBPROJ

SinOption se establece en SCC_OPT_SHARESUBPROJ, el IDE está probando si el complemento de control de código fuente puede usar una carpeta local especificada al agregar los archivos de control de código fuente. El valor del parámetro de dwVal no importa en este caso. Si el complemento permite que el IDE especifique la carpeta de destino local donde los archivos se agregarán de control de código fuente cuando se llama SccAddFromScc (Función) , el complemento debe devolver SCC_I_SHARESUBPROJOK cuando se llama a la función de SccSetOption . El IDE utiliza después el parámetro de lplpFileNames de la función de SccAddFromScc para pasar en la carpeta de destino. El complemento utiliza que carpeta de destino para colocar los archivos agregados de control de código fuente. Si el complemento no devuelve SCC_I_SHARESUBPROJOK cuando la opción de SCC_OPT_SHARESUBPROJ , el IDE supone que el complemento puede agregar los archivos en la carpeta local actual.