ORDKEYADD()
 Añade una clave a un orden personalizado
------------------------------------------------------------------------------
 Sintaxis

     ORDKEYADD([<cOrden> | <nPosición>],
        [<cFichIndice>],[<expValorClave>]) --> lExito

 Argumentos

     <cOrden> | <nPosición> es el nombre del orden o un número que
     representa su posición en la lista de órdenes. Es preferible utilizar
     un nombre en vez de una posición ya que con esta última puede existir
     confusión en ficheros índice con varios órdenes. Si se omite o se
     establece a NIL, se utiliza el orden de control por defecto.

     Si especifica un orden no válido, por ejemplo un orden que no sea
     personalizado, se produce un error en ejecución.

     <cFichIndice> es el nombre de un fichero índice, incluidos
     opcionalmente la unidad y el directorio (no es necesario especificar la
     extensión). Este argumento puede utilizarse junto con <cOrden> para
     deshacer la ambigüedad en situaciones en las que existen dos o más
     órdenes con el mismo nombre en ficheros índice distintos.

     Si el proceso actual no ha abierto <cFichIndice>, se produce un error
     de ejecución.

     <expValorClave> es el valor clave que se va a añadir al registro
     actual. El tipo de datos debe coincidir con el del orden. Si no se
     especifica, se evalúa la expresión clave en el registro actual y se
     añade al orden.

 Devuelve

     ORDKEYADD() devuelve el valor verdadero (.T.) si la ejecución de la
     función es satisfactoria; de lo contrario, devuelve el valor falso
      (.F.).

 Descripción

     ORDKEYADD() añade claves a un orden personalizado (aquel que el
     controlador DBFCDX no actualiza de forma automática). Se puede
     averiguar si un orden es personalizado utilizando
     DBORDERINFO(DBOI_CUSTOM, ...). Inicialmente el orden está vacío. Para
     añadir y eliminar claves de forma manual hay que utilizar las funciones
     ORDKEYADD() y ORDKEYDEL().

     Nota: Un orden existente se puede convertir en un orden
     personalizado llamando a la función DBORDERINFO().

     ORDKEYADD() evalúa la expresión clave (o <expValorClave>, si se
     indica), y a continuación añade la clave al registro actual del orden.
     Para añadir una clave a un orden que posee una condición FOR, la clave
     debe satisfacer la condición y estar comprendida en el rango del ámbito
     actual.

     Nota: Es posible añadir varias claves a un mismo registro mediante
     llamadas sucesivas a ORDKEYADD().

     ORDKEYADD() no se ejecuta de forma satisfactoria si:

      El puntero del registro está situado en un registro no válido
        (EOF() devuelve verdadero)

      El orden especificado no es personalizado

      El orden especificado no existe

      No se ha especificado ningún orden y no existe orden de
        control

     Por defecto, esta función opera en el área de trabajo seleccionada. Si
     desea utilizarla en otra área de trabajo, debe especificarla con una
     expresión de alias.

 Ejemplos

      Este ejemplo crea un índice personalizado en el que incluye
        uno de cada cincuenta registros:

        USE Cliente VIA "DBFCDX"
        // Crea un orden personalizado vacío
        INDEX ON Apellidos TO Apell CUSTOM

        // Añade un registro cada cincuenta
        FOR n := 1 TO RECCOUNT() STEP 50
           GOTO n
           ORDKEYADD()
        NEXT

 Ficheros   La biblioteca asociada es CLIPPER.LIB.

 To download this example - click here.

See Also: ORDFOR() ORDKEYDEL() ORDSCOPE()