SccQueryInfo (función)SccQueryInfo Function

Esta función obtiene información de estado para un conjunto de archivos seleccionados en el control de código fuente.This function obtains status information for a set of selected files under source control.

SintaxisSyntax

SCCRTN SccQueryInfo(  
   LPVOID  pvContext,  
   LONG    nFiles,  
   LPCSTR* lpFileNames,  
   LPLONG  lpStatus  
);  

ParámetrosParameters

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

nFilesnFiles
[in] Número de archivos especificado en el lpFileNames matriz y la longitud de la lpStatus matriz.[in] Number of files specified in the lpFileNames array and the length of the lpStatus array.

lpFileNameslpFileNames
[in] Una matriz de nombres de archivos que se va a consultar.[in] An array of names of files to be queried.

lpStatuslpStatus
[entrada, salida] Una matriz en el que el complemento de control de código fuente devuelve las marcas de estado para cada archivo.[in, out] An array in which the source control plug-in returns the status flags for each file. Para obtener más información, consulte código de estado de archivo.For more information, see File Status Code.

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 Consulta fue correcta.Query was successful.
SCC_E_ACCESSFAILURESCC_E_ACCESSFAILURE Hubo un problema con obtener acceso al sistema de control de código fuente, deberse a problemas de red o de contención.There was a problem with accessing the source control system, probably caused by network or contention issues. Se recomienda un reintento.A retry is recommended.
SCC_E_PROJNOTOPENSCC_E_PROJNOTOPEN El proyecto no está abierto en el control de código fuente.The project is not open under source control.
SCC_E_NONSPECIFICERRORSCC_E_NONSPECIFICERROR Error no determinado.Nonspecific failure.

ComentariosRemarks

Si lpFileName es una cadena vacía, actualmente no hay ninguna información de estado para la actualización.If lpFileName is an empty string, there is currently no status information to update. En caso contrario, es el nombre de ruta de acceso completa del archivo para el que puede haber cambiado la información de estado.Otherwise, it is the full path name of the file for which the status information may have changed.

La matriz de valor devuelta puede ser una máscara de bits de SCC_STATUS_xxxx bits.The return array can be a bitmask of SCC_STATUS_xxxx bits. Para obtener más información, consulte código de estado de archivo.For more information, see File Status Code. Un sistema de control de código fuente no puede admitir todos los tipos de bits.A source control system may not support all bit types. Por ejemplo, si SCC_STATUS_OUTOFDATE no está disponible, pero no está establecido el bit.For example, if SCC_STATUS_OUTOFDATE is not offered, the bit is just not set.

Al utilizar esta función para desproteger los archivos, tenga en cuenta lo siguiente MSSCCI requisitos de estado:When using this function to check out files, note the following MSSCCI status requirements:

  • SCC_STATUS_OUTBYUSERse establece cuando el usuario actual ha desprotegido el archivo.SCC_STATUS_OUTBYUSER is set when the current user has checked out the file.

  • SCC_STATUS_CHECKEDOUTno se puede establecer a menos que SCC_STATUS_OUTBYUSER se establece.SCC_STATUS_CHECKEDOUT cannot be set unless SCC_STATUS_OUTBYUSER is set.

  • SCC_STATUS_CHECKEDOUTsólo se establece cuando el archivo está desprotegido en el directorio de trabajo designado.SCC_STATUS_CHECKEDOUT is only set when the file is checked-out into the designated working directory.

  • Si el archivo está desprotegido por el usuario actual en un directorio distinto al directorio de trabajo SCC_STATUS_OUTBYUSER está establecido, pero SCC_STATUS_CHECKEDOUT no es.If the file is checked-out by the current user into a directory other than the working directory, SCC_STATUS_OUTBYUSER is set but SCC_STATUS_CHECKEDOUT is not.

Vea tambiénSee Also

Funciones de API de complemento de Control de código fuente Source Control Plug-in API Functions
Código de estado de archivoFile Status Code