# db2_get_option

(PECL ibm_db2 >= 1.6.0)

db2_get_option — Devolver el valor de la opción correpondiente a una conexión o sentencia

### Descripción

db2_get_option(resource `$resource`, string `$option`): string

Devuelve el valor de la opción especificada para una conexión o sentencia.

### Parámetros

`resource`

  Un recurso válido devuelto por db2_prepare() o devuelto por db2_connect() o db2_pconnect().

`option`

  Opciones válidas para la sentencia o conexión. Las nuevas opciones siguientes están disponibles a partir de la versión 1.6.0 de ibm_db2. Proveen información de rastreo útil que puede ser establecida durante la ejecución con db2_get_option().

  > Nota:

  > Las versiones anteriores de ibm_db2 no soportan estas nuevas opciones.

  > Cuando el valor de cada opción se establece, es posible que algunos servidores no manejen toda la longitud especificada y puede que el valor sea truncado.

  > Para asegurar que la información especificada en cada opción sea convertida correctamente cuando se transmita a un Host utilice únicamente caracteres de la A a la Z, 0 a 9, guiones bajos (_) y puntos (.).

  `userid`

    `SQL_ATTR_INFO_USERID` - Un apuntador a una cadena que representa el identificador del cliente enviado al servidor cuando se conecta al servidor usando db2_connect().

    > Nota:

    > Los servidores z/OS y OS/390 soportan longitudes hasta 16 caracteres. Este identificador de usuario no debe ser confundido con el usuario de autenticación, sólo es para propósitos de identificación y no se usa para autorización.

  `acctstr`

    `SQL_ATTR_INFO_ACCTSTR` - Un apuntador a una cadena utilizada para identificar la cuenta del cliente enviada al Host cuando se conecta al servidor usando db2_connect().

    > Nota:

    > Los servidores z/OS y OS/390 soportan longitudes de hasta 200 caracteres.

  `applname`

    `SQL_ATTR_INFO_APPLNAME` - Un apuntador a una cadena utilizada para identificar el nombre de la aplicación del cliente enviado al Host cuando se conecta al servidor usando db2_connect().

    > Nota:

    > Los servidores z/OS y OS/390 soportan longitudes de hasta 32 caracteres.

  `wrkstnname`

    `SQL_ATTR_INFO_WRKSTNNAME` - Un apuntador a una cadena utilizada para identificar el nombre de la estación de trabajo del cliente enviado al Host cuando se conecta al servidor usando db2_connect().

    > Nota:

    > Los servidores z/OS y OS/390 soportan longitudes de hasta 18 caracteres.

La siguiente tabla especifica cuáles opciones son compatibles con los tipos de recurso disponibles:

Matriz Recursos-Paramétros
Clave | Valor | Tipo de recurso
--- | --- | ---
|  | Conección | Sentencia | Resultado
userid | `SQL_ATTR_INFO_USERID` | X | X | -
acctstr | `SQL_ATTR_INFO_ACCTSTR` | X | X | -
applname | `SQL_ATTR_INFO_APPLNAME` | X | X | -
wrkstnname | `SQL_ATTR_INFO_WRKSTNNAME` | X | X | -

### Valores devueltos

Devuelve la configuración actual del atributo especificado en la conexión en caso de éxito o `false` en caso de error.

### Ejemplos

Ejemplo #1 Estableciendo y extrayendo parámetros a través de una conexión

`<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$user = 'db2inst1';
$password = 'ibmdb2';
/* Obtain Connection Resource */
$conn = db2_connect($database, $user, $password);
echo "Client attributes passed through connection string:\n";
/* Create the associative options array with valid key-value pairs */
/* Assign the attributes through connection string */
/* Access the options specified */
$options1 = array('userid' => 'db2inst1');
$conn1 = db2_connect($database, $user, $password, $options1);
$val = db2_get_option($conn1, 'userid');
echo $val . "\n";
$options2 = array('acctstr' => 'account');
$conn2 = db2_connect($database, $user, $password, $options2);
$val = db2_get_option($conn2, 'acctstr');
echo $val . "\n";
$options3 = array('applname' => 'myapp');
$conn3 = db2_connect($database, $user, $password, $options3);
$val = db2_get_option($conn3, 'applname');
echo $val . "\n";
$options4 = array('wrkstnname' => 'workstation');
$conn4 = db2_connect($database, $user, $password, $options4);
$val = db2_get_option($conn4, 'wrkstnname');
echo $val . "\n";
echo "Client attributes passed post-connection:\n";
/* Create the associative options array with valid key-value pairs */
/* Assign the attributes after a connection is made */
/* Access the options specified */
$options5 = array('userid' => 'db2inst1');
$conn5 = db2_connect($database, $user, $password);
$rc = db2_set_option($conn5, $options5, 1);
$val = db2_get_option($conn5, 'userid');
echo $val . "\n";
$options6 = array('acctstr' => 'account');
$conn6 = db2_connect($database, $user, $password);
$rc = db2_set_option($conn6, $options6, 1);
$val = db2_get_option($conn6, 'acctstr');
echo $val . "\n";
$options7 = array('applname' => 'myapp');
$conn7 = db2_connect($database, $user, $password);
$rc = db2_set_option($conn7, $options7, 1);
$val = db2_get_option($conn7, 'applname');
echo $val . "\n";
$options8 = array('wrkstnname' => 'workstation');
$conn8 = db2_connect($database, $user, $password);
$rc = db2_set_option($conn8, $options8, 1);
$val = db2_get_option($conn8, 'wrkstnname');
echo $val . "\n";
?>`

El resultado del ejemplo sería:

    Client attributes passed through connection string:
    db2inst1
    account
    myapp
    workstation
    Client attributes passed post-connection:
    db2inst1
    account
    myapp
    workstation

### Ver también

- db2_connect() - Devolver una conexión a la base de datos
- db2_cursor_type() - Determinar el tipo de cursor utilizado en una consulta
- db2_exec() - Ejecutar directamente una sentencia SQL
- db2_set_option() - Set options for connection or statement resources
- db2_pconnect() - Devolver una conexión persistente a la base de datos
- db2_prepare() - Prepara un comando SQL para su ejecución