SccSetOption (función)SccSetOption Function

Esta función establece las opciones que controlan el comportamiento del complemento de control de código fuente.This function sets options that control the behavior of the source control plug-in.

SintaxisSyntax

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

ParámetrosParameters

pvContextpvContext
[in] La estructura de contexto de complemento de control de código fuente.[in] The source control plug-in context structure.

nOptionnOption
[in] La opción que se va a establecer.[in] The option that is being set.

dwValdwVal
[in] Configuración para la opción.[in] Settings for the option.

Valor devueltoReturn Value

La implementación de complemento de control de origen de esta función debe devolver uno de los siguientes valores:The source control plug-in implementation of this function is expected to return one of the following values:

ValorValue DescripciónDescription
SCC_OKSCC_OK La opción se estableció correctamente.The option was successfully set.
SCC_I_SHARESUBPROJOKSCC_I_SHARESUBPROJOK Se devuelve si nOption era SCC_OPT_SHARESUBPROJ y el complemento de control de código fuente permite que el IDE establecer la carpeta de destino.Returned if nOption was SCC_OPT_SHARESUBPROJ and the source control plug-in allows the IDE to set the destination folder.
SCC_E_OPNOTSUPPORTEDSCC_E_OPNOTSUPPORTED La opción no se ha establecido y no debe confiar en.The option was not set and should not be relied upon.

ComentariosRemarks

El IDE llama a esta función para controlar el comportamiento del complemento de control de código fuente.The IDE calls this function to control the behavior of the source control plug-in. El primer parámetro, nOption, indica el valor que se está estableciendo, mientras que la segunda, dwVal, indica qué hacer con ese valor.The first parameter, nOption, indicates the value that is being set, while the second, dwVal, indicates what to do with that value. El complemento almacena esta información asociada con un pvContext``, por lo que el IDE debe llamar a esta función después de llamar a la SccInitialize (pero no necesariamente después de cada llamada a la SccOpenProject).The plug-in stores this information associated with a pvContext``, so the IDE must call this function after calling the SccInitialize (but not necessarily after each call to the SccOpenProject).

Resumen de las opciones y sus valores:Summary of the options and their values:

nOption dwValue DescripciónDescription
SCC_OPT_EVENTQUEUE SCC_OPT_EQ_DISABLE

SCC_OPT_EQ_ENABLE
Habilita o deshabilita en segundo plano puesta en cola eventos.Enables/disables background event queuing.
SCC_OPT_USERDATA Valor arbitrarioArbitrary value Especifica un valor de usuario que se pasan a la OPTNAMECHANGEPFN función de devolución de llamada.Specifies a user value to be passed to the OPTNAMECHANGEPFN callback function.
SCC_OPT_HASCANCELMODE SCC_OPT_HCM_NO

SCC_OPT_HCM_YES
Indica si el IDE actualmente admite la cancelación de una operación.Indicates whether the IDE currently supports canceling an operation.
SCC_OPT_NAMECHANGEPFN Puntero a la OPTNAMECHANGEPFN callback (función)Pointer to the OPTNAMECHANGEPFN callback function Establece un puntero a una función de devolución de llamada de cambio de nombre.Sets a pointer to a name-change callback function.
SCC_OPT_SCCCHECKOUTONLY SCC_OPT_SCO_NO

SCC_OPT_SCO_YES
Indica si el IDE permite la comprobación fuera de sus archivos de forma manual (a través de la interfaz de usuario de control de código fuente) o si debe desproteger sólo mediante el complemento de control de código fuente.Indicates whether the IDE allows the checking out of its files manually (through the source control user interface) or whether they must be checked out only through the source control plug-in.
SCC_OPT_SHARESUBPROJ N/DN/A Si el complemento de control de código fuente permite el IDE especificar la carpeta de proyecto local, el complemento devuelve SCC_I_SHARESUBPROJOK.If the source control plug-in allows the IDE to specify the local project folder, the plug-in returns SCC_I_SHARESUBPROJOK.

SCC_OPT_EVENTQUEUESCC_OPT_EVENTQUEUE

Si nOption es SCC_OPT_EVENTQUEUE, el IDE es deshabilitar (o volver a habilitar) procesamiento en segundo plano.If nOption is SCC_OPT_EVENTQUEUE, the IDE is disabling (or re-enabling) background processing. Por ejemplo, durante una compilación, el IDE podría indicar que el complemento para detener el procesamiento en inactividad de cualquier tipo de control de código fuente.For instance, during a compile, the IDE might instruct the source control plug-in to stop on-idle processing of any kind. Después de la compilación, lo que permitiría volver a procesamiento en segundo plano para mantener actualizada de la cola de eventos del complemento.After the compile, it would re-enable background processing to keep the plug-in's event queue up to date. Correspondiente a la SCC_OPT_EVENTQUEUE valo nOption, hay dos valores posibles para dwVal, es decir, SCC_OPT_EQ_ENABLE y SCC_OPT_EQ_DISABLE.Corresponding to the SCC_OPT_EVENTQUEUE value of nOption, there are two possible values for dwVal, namely, SCC_OPT_EQ_ENABLE and SCC_OPT_EQ_DISABLE.

SCC_OPT_HASCANCELMODESCC_OPT_HASCANCELMODE

Si el valor de nOption es SCC_OPT_HASCANCELMODE, el IDE permite a los usuarios cancelar operaciones de larga duración.If the value for nOption is SCC_OPT_HASCANCELMODE, the IDE allows users to cancel long operations. Establecer dwVal a SCC_OPT_HCM_NO (valor predeterminado) indica que el IDE no tiene ningún modo de cancelar.Setting dwVal to SCC_OPT_HCM_NO (the default) indicates that the IDE has no cancel mode. El complemento de control de código fuente debe ofrecer su propio botón Cancelar si desea que el usuario pueda cancelar.The source control plug-in must offer its own Cancel button if it wants the user to be able to cancel. SCC_OPT_HCM_YESindica que el IDE proporciona la capacidad para cancelar una operación, por lo que no es necesario que el complemento de SCC mostrar su propio botón de cancelación.SCC_OPT_HCM_YES indicates that the IDE provides the ability to cancel an operation, so the SCC plug-in does not need to display its own Cancel button. Si establece el IDE dwVal a SCC_OPT_HCM_YES, ya está preparado para responder a SCC_MSG_STATUS y DOCANCEL mensajes enviados a la lpTextOutProc función de devolución de llamada (vea LPTEXTOUTPROC).If the IDE sets dwVal to SCC_OPT_HCM_YES, it is prepared to respond to SCC_MSG_STATUS and DOCANCEL messages sent to the lpTextOutProc callback function (see LPTEXTOUTPROC). Si no establece esta variable para el IDE, el complemento no debe enviar estos dos mensajes.If the IDE does not set this variable, the plug-in should not send these two messages.

SCC_OPT_NAMECHANGEPFNSCC_OPT_NAMECHANGEPFN

Si se establece nOption en SCC_OPT_NAMECHANGEPFNy tanto el origen de complemento de control y el IDE permiten, el complemento puede realmente cambiar el nombre o mover un archivo durante una operación de control de código fuente.If nOption is set to SCC_OPT_NAMECHANGEPFN, and both the source control plug-in and the IDE allow it, the plug-in can actually rename or move a file during a source control operation. El dwVal se establecerá en un puntero a función de tipo OPTNAMECHANGEPFN.The dwVal will be set to a function pointer of type OPTNAMECHANGEPFN. Durante una operación de control de código fuente, el complemento puede llamar a esta función, pasando tres parámetros.During a source control operation, the plug-in can call this function, passing in three parameters. Estas son el nombre antiguo (con la ruta de acceso completa) de un archivo, el nuevo nombre (con la ruta de acceso completa) de ese archivo y un puntero a la información que tenga importancia para el IDE.These are the old name (with fully qualified path) of a file, the new name (with fully qualified path) of that file, and a pointer to information that has relevance to the IDE. El IDE envía en este puntero del último mediante una llamada a SccSetOption con nOption establecido en SCC_OPT_USERDATA, con dwVal que apunta a los datos.The IDE sends in this last pointer by calling SccSetOption with nOption set to SCC_OPT_USERDATA, with dwVal pointing to the data. Compatibilidad con esta función es opcional.Support for this function is optional. Un enchufe VSSCI-que usa esta capacidad debe inicializar variables de datos de su puntero y del usuario de función para NULL, y no debe llamar a una función de cambio de nombre a menos que se le ha asignado uno.A VSSCI plug-that uses this ability must initialize its function pointer and user data variables to NULL, and it must not call a rename function unless it has been given one. También debe prepararán para contener el valor que se especificó o cambian en respuesta a una nueva llamada a SccSetOption.It should also be prepared to hold the value it was given or to change it in response to a new call to SccSetOption. Esto no se realizará en el medio de una operación de comando de control de código fuente, pero puede ocurrir entre los comandos.This will not happen in the middle of a source control command operation, but it may happen between commands.

SCC_OPT_SCCCHECKOUTONLYSCC_OPT_SCCCHECKOUTONLY

Si se establece nOption en SCC_OPT_SCCCHECKOUTONLY, el IDE es que indica que los archivos en el proyecto abierto actualmente no deben nunca se extraiga del repositorio manualmente a través de la interfaz de usuario del sistema de control de código fuente.If nOption is set to SCC_OPT_SCCCHECKOUTONLY, the IDE is indicating that the files in the currently open project should never be checked out manually through the source control system's user interface. En su lugar, se deben desproteger los archivos sólo mediante el complemento bajo el control IDE de control de código fuente.Instead, the files should be checked out only through the source control plug-in under IDE control. Si dwValue se establece en SCC_OPT_SCO_NO, significa que los archivos deben tratarse normalmente por el complemento y que se pueden comprobar mediante la interfaz de usuario de control de código fuente.If dwValue is set to SCC_OPT_SCO_NO, it means that the files should be treated normally by the plug-in and can be checked out through the source control UI. Si dwValue se establece en SCC_OPT_SCO_YES, a continuación, se permite solo el complemento desproteger los archivos y no se debe invocar interfaz de usuario del sistema de control de origen.If dwValue is set to SCC_OPT_SCO_YES, then only the plug-in is allowed to check out files, and the source control system's UI should not be invoked. Esto es en situaciones donde el IDE podría tener "archivos pseudo" que tengan sentido para desproteger solo a través del IDE.This is for situations where the IDE might have "pseudo-files" that make sense to check out only through the IDE.

SCC_OPT_SHARESUBPROJSCC_OPT_SHARESUBPROJ

SinOption se establece en SCC_OPT_SHARESUBPROJ, el IDE se prueba si el complemento de control de código fuente puede usar una carpeta local especificada al agregar archivos de control de código fuente.IfnOption is set to SCC_OPT_SHARESUBPROJ, the IDE is testing whether the source control plug-in can use a specified local folder when adding files from source control. El valor de la dwVal parámetro no es relevante en este caso.The value of the dwVal parameter does not matter in this case. Si el complemento permite que el IDE especificar la carpeta de destino local donde se agregará los archivos de origen y controla cuándo el SccAddFromScc se llama, a continuación, el complemento debe devolver SCC_I_SHARESUBPROJOK cuando el SccSetOption función es se llama.If the plug-in allows the IDE to specify the local destination folder where the files will be added from source control when the SccAddFromScc is called, then the plug-in must return SCC_I_SHARESUBPROJOK when the SccSetOption function is called. El IDE, a continuación, usa el lplpFileNames parámetro de la SccAddFromScc función pasar en la carpeta de destino.The IDE then uses the lplpFileNames parameter of the SccAddFromScc function to pass in the destination folder. El complemento utiliza esa carpeta de destino para colocar los archivos agregados desde el control de código fuente.The plug-in uses that destination folder to place the files added from source control. Si el complemento no devuelve SCC_I_SHARESUBPROJOK cuando el SCC_OPT_SHARESUBPROJ opción está activada, el IDE se da por supuesto que el complemento es capaz de agregar archivos en la carpeta local actual.If the plug-in does not return SCC_I_SHARESUBPROJOK when the SCC_OPT_SHARESUBPROJ option is set, the IDE assumes that the plug-in is able to add files only in the current local folder.

Vea tambiénSee Also

Funciones de API de complemento de Control de código fuente Source Control Plug-in API Functions
SccInitialize SccInitialize
SccOpenProject SccOpenProject
SccAddFromScc SccAddFromScc
LPTEXTOUTPROC LPTEXTOUTPROC
OPTNAMECHANGEPFNOPTNAMECHANGEPFN