Share via


KEYMATCH( ) (Función)

Busca una clave de índice en una etiqueta o un archivo de índice.

KEYMATCH(eIndexKey [, nIndexNumber [, nWorkArea | cTableAlias]])

Valores devueltos

Logical

Parámetros

  • eIndexKey
    Especifica la clave de índice buscada por KEYMATCH( ). Las claves de índice de un archivo o una etiqueta de índice están determinadas por la expresión de índice. Una expresión de índice se especifica cuando se crea un archivo o una etiqueta de índice mediante INDEX. KEY( ) y SYS(14) se utilizan para devolver las expresiones de índice para archivos de índice y etiquetas de índice. Para obtener más información acerca de cómo crear archivos de índice, expresiones de índice y claves de índice, vea INDEX.

    Si no incluye ninguno de los parámetros opcionales, KEYMATCH( ) buscará la clave de índice especificada en el archivo o la etiqueta de índice maestro. Si no hay ninguna etiqueta ni archivo de índice maestro activos (por ejemplo, si ha ejecutado SET ORDER TO sin ningún parámetro para colocar la tabla en el orden natural de los registros), Visual FoxPro generará un mensaje de error.

  • nIndexNumber
    Especifica el archivo de índice o la etiqueta de índice que se va a buscar. nIndexNumber es normalmente un entero que comienza en 1 y aumenta de uno en uno para buscar etiquetas de índice adicionales.

    Si nIndexNumber es 1, se buscará en el archivo de índice maestro .IDX de una sola entrada o en la etiqueta de índice maestro (si hay alguno presente).

    A medida que nIndexNumber aumenta, se buscan las etiquetas posteriores del índice compuesto estructural (si hay alguno presente). Las etiquetas se buscan en el mismo orden en que se crearon dentro del índice compuesto estructural.

    Cuando nIndexNumber continúa aumentando y ha terminado de buscar todas las etiquetas del índice compuesto estructural, buscará las etiquetas de cualquier índice compuesto independiente que esté abierto. Las etiquetas se buscan en el mismo orden en que se crearon en los índices compuestos independientes.

    Se genera un mensaje de error si nIndexNumber es mayor que el número total de archivos .IDX de una sola entrada abiertos más las etiquetas de índice compuesto estructural y compuesto independiente.

  • nWorkArea | cTableAlias
    Busca archivos o etiquetas de índice abiertos en otra área de trabajo. nWorkArea especifica el número del área de trabajo y cTableAlias especifica el alias de la tabla. Si omite el área de trabajo y el alias, KEYMATCH( ) buscará archivos o etiquetas de índice abiertos para la tabla en el área de trabajo actual.

    Si ninguna tabla tiene el alias especificado, Visual FoxPro mostrará un mensaje de error.

Observaciones

KEYMATCH( ) busca en una etiqueta o en un archivo de índice una clave de índice específica y devuelve verdadero (.T.) si encuentra dicha clave de índice; de lo contrario, KEYMATCH( ) devolverá falso (.F.). KEYMATCH( ) se puede usar para impedir la duplicación de claves de índice.

KEYMATCH( ) devuelve el puntero de registro al registro donde estaba originalmente antes de ejecutar KEYMATCH( ).

Vea también

INDEX | INDEXSEEK( ) | KEY( ) | SET INDEX | SYS(14) | USE