# API

API es el acrónimo del inglés “Application Programming Interface” (Interfaz de Programación de Aplicaciones). Se trata de un conjunto de comandos que nos permiten interactuar con las [tablas ](tablas)contenidas en el [proyecto de datos](../../../../buenas-practicas-de-programacion/buenas-practicas-de-organizacion/proyecto-de-datos-1-carpetas-esquemas-tablas-e-indices-complejos) en curso o en un proyecto de datos [heredado](../../../../herencia).

Estos comandos figuran como obsoletos a partir de la versión 7.19, aunque seguirán funcionando.

En próximas versiones podrán desaparecer, así que recomendamos su sustitución por el [API de Velneo para JavaScript](../../../../scripts).

## APIVEL: Get nombre de campo por número

Comando de instrucción del grupo API de Velneo que devuelve el **nombre** de un [campo](../../../editores/asistente-de-formulas/campos) en función de la posición.

Este comando figura como obsoletos a partir de la versión 7.19, aunque seguirá funcionando.

En próximas versiones podrá desaparecer, así que recomendamos su sustitución por el [API de Velneo para JavaScript](../../../../scripts).

**Origen de la instrucción**: Cualquiera.

**Destino del subproceso**: Ninguno.

### Parámetros

#### Identificador de tabla

Identificador de la tabla de la que queremos obtener la información. Para facilitar su especificación, este parámetro desplegará la lista de tablas de los proyectos de datos.

#### Fórmula de número de campo

Expresión fórmula que contendrá el número (la posición) del campo de la tabla seleccionada en el parámetro anterior cuyo nombre queremos obtener.

#### Identificador de variable local alfabética de retorno

Identificador de la [variable local](../../variable-local) del proceso que recogerá el nombre del campo.

### **Funcionalidad**

Este comando devuelve la etiqueta **Nombre** del campo de la tabla pasada como parámetro, correspondiente a la posición indicada en el segundo parámetro y la guarda en la variable local declarada en el último parámetro.

### **Comentarios**

La variable local podrá ser tanto una de las locales al proceso o una nueva.

El orden que se sigue es el orden que tengan los campos de la tabla dentro del proyecto de datos.

El primer campo se corresponderá con la posición 0.

El equivalente a este comando de instrucción de proceso en el API de Velneo para JavaScript es la función fieldName( Number nCampo ) de la clase VTableInfo.

### Ejemplo

Obtener el contenido del campo del primer registro de la tabla de artículos ART\_M mostrándolo mediante un mensaje.

```
Cargar lista ( ART_M@velneo_vTutor_dat, ID, 1, , ,  )
    Seleccionar ficha por posición ( 1 )
    Leer ficha seleccionada
    APIVEL: Get campo por numero ( 1, CONTENIDO )
    Mensaje ( "Valor del primer campo de la tabla de artículos: " + CONTENIDO, Información, ,  )
```

## APIVEL: Get nombre de campo por identificador

Comando de instrucción del grupo API de Velneo que devuelve el **nombre** de un campo en función del **identificador**.

Este comando figura como obsoletos a partir de la versión 7.19, aunque seguirá funcionando.

En próximas versiones podrá desaparecer, así que recomendamos su sustitución por el [API de Velneo para JavaScript](../../../../scripts).

**Origen de la instrucción**: Cualquiera.

**Destino del subproceso**: Ninguno.

### Parámetros

#### Identificador de tabla

Identificador de la tabla de la que queremos obtener la información. Para facilitar su especificación, este parámetro desplegará la lista de tablas de los proyectos de datos.

#### Identificador de campo de la tabla seleccionada

Identificador del campo de la tabla seleccionada en el parámetro anterior cuyo nombre queremos obtener. Para facilitar su especificación, este parámetro desplegará la lista de campos de la misma.

#### Identificador de variable local alfabética de retorno

Identificador de la variable local del proceso que recogerá el nombre del campo.

### **Funcionalidad**

Este comando devuelve la etiqueta **Nombre** del campo de la tabla pasados como parámetros, y la guarda en la variable local en el último parámetro.

### **Comentarios**

La variable local podrá ser tanto una de las locales al proceso o una nueva.

El equivalente a este comando de instrucción de proceso en el API de Velneo para JavaScript es la función **fieldName( String szIDPrimarioCampo )** de la clase VTableInfo.

### Ejemplo

Obtener la propiedad Nombre del campo NAME de la tabla de artículos ART\_M.

```
APIVEL: Get nombre de campo por identificador ( ART_M@velneo_vTutor_dat, NAME, CONTENIDO )
Mensaje ( "Propiedad Nombre del campo NAME: " + CONTENIDO, Información, ,  )
```

## APIVEL: Get campo por número

Comando de instrucción del grupo API de Velneo que devuelve el contenido de un campo en función de la posición.

Este comando figura como obsoletos a partir de la versión 7.19, aunque seguirá funcionando.

En próximas versiones podrá desaparecer, así que recomendamos su sustitución por el [API de Velneo para JavaScript](../../../../scripts).

**Origen de la instrucción**: Ficha de la tabla en curso.

**Destino del subproceso**: Ninguno.

### Parámetros

#### Fórmula de número de campo

Expresión fórmula que contendrá el número (la posición) del campo cuyo valor queremos obtener.

#### Identificador de variable local alfabética de retorno

Identificador de la variable local del proceso que recogerá el contenido del campo.

#### **Funcionalidad**

Este comando devuelve el valor del campo que se corresponde con la posición indicada en el primer parámetro y lo guarda en la variable local declarada en el último parámetro.

### **Comentarios**

La variable local podrá ser tanto una de las locales al proceso o una nueva.

El orden que se sigue es el orden que tengan los campos de la tabla dentro del proyecto de datos.

El primer campo se corresponderá con la posición 0.

El equivalente a este comando de instrucción de proceso en el API de Velneo para JavaScript son las **funciones de contenido de campos por número de campo** de la clase VRegister.

## APIVEL: Get número de campo por identificador

Comando de instrucción del grupo API de Velneo que devuelve el número de un campo en función del identificador.

Este comando figura como obsoletos a partir de la versión 7.19, aunque seguirá funcionando.

En próximas versiones podrá desaparecer, así que recomendamos su sustitución por el [API de Velneo para JavaScript](../../../../scripts).

**Origen de la instrucción**: Cualquiera.

**Destino del subproceso**: Ninguno.

### Parámetros

#### Identificador de tabla

Identificador de la tabla de la que queremos obtener la información. Para facilitar su especificación, este parámetro desplegará la lista de tablas de los proyectos de datos.

#### Identificador de campo de la tabla seleccionada

Identificador del campo del que queremos obtener el número. Para facilitar su especificación, este parámetro desplegará la lista de campos de la tabla seleccionada en el parámetro anterior.

#### Identificador de variable local numérica de retorno

Identificador de la variable local del proceso que recogerá el número del campo.

### **Funcionalidad**

Este comando devuelve el número del campo de la tabla pasados como parámetros y lo guarda en la variable local declarada en el último parámetro.

### **Comentarios**

La variable local podrá ser tanto una de las locales al proceso como una nueva.

El número se corresponderá con el orden que tengan los campos de la tabla dentro del proyecto de datos.

El primer campo se corresponderá con el número 0.

## APIVEL: Get número de campos

Comando de instrucción del grupo API de Velneo que devuelve el número de campos de una tabla.

Este comando figura como obsoletos a partir de la versión 7.19, aunque seguirá funcionando.

En próximas versiones podrá desaparecer, así que recomendamos su sustitución por el [API de Velneo para JavaScript](../../../../scripts).

**Origen de la instrucción**: Cualquiera.

**Destino del subproceso**: Ninguno.

### Parámetros

#### Identificador de tabla

Identificador de la tabla de la que queremos obtener la información. Para facilitar su especificación, este parámetro desplegará la lista de tablas de los proyectos de datos.

#### Identificador de variable local numérica de retorno

Identificador de la variable local del proceso que recogerá el número de campos de la tabla.

### **Funcionalidad**

Este comando devuelve el número de campos de la tabla que se pasa en el parámetro y lo guarda en la variable local declarada en el segundo parámetro.

### **Comentarios**

La variable local podrá ser tanto una de las locales al proceso o una nueva.

El equivalente a este comando de instrucción de proceso en el API de Velneo para JavaScript es la función **fieldCount()** de la clase VTableInfo.
