# db2_get_option

(PECL ibm_db2 >= 1.6.0)

db2_get_option — Récupère la valeur d'une option pour une requête ou une connexion

### Description

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

Récupère la valeur d'une option spécifiée pour une ressource de requête ou une ressource de connexion.

### Liste de paramètres

`resource`

  Une ressource de requête valide retournée par db2_prepare() ou une ressource de connexion valide retournée par db2_connect() ou db2_pconnect().

`option`

  Des options de requête ou de connexion valides. Les nouvelles options suivantes sont disponibles depuis la version 1.6.0 de ibm_db2. Elles fournissent d'utiles informations de traçage qui peuvent être fixées pendant l'exécution avec db2_get_option().

  > Note:

  > Les anciennes versions de ibm_db ne supportent pas ces nouvelles options.

  > Lorsqu'une valeur dans chaque option est fixée, certains serveurs peuvent ne pas prendre en charge la valeur totale fournie et peuvent tronquer cette valeur.

  > Pour s'assurer que les données spécifiées dans chaque option sont converties correctement lors de la transmission vers une base de données, utilisez seulement les caractères de A à Z, 0 à 9 et les caractères de soulignement (_) ou point (.).

  `userid`

    `SQL_ATTR_INFO_USERID` : un pointeur vers une chaîne de caractères utilisée pour identifier l'identifiant de l'usager (ID) envoyé vers le serveur de base de données lors de la connexion à DB2.

    > Note:

    > DB2 pour les serveurs z/OS et OS/390 supportent jusqu'à 16 caractères. Le user-id ne doit pas être confondu avec l'identification user-id ; il s'agit seulement d'un but d'identification et ne doit pas être autorisé pour des autorisations.

  `acctstr`

    `SQL_ATTR_INFO_ACCTSTR` : un pointeur vers une chaîne de caractères utilisée pour identifier le compte du client envoyé vers le serveur de base de données lors de la connexion à DB2.

    > Note:

    > DB2 pour les serveurs z/OS et OS/390 supportent jusqu'à 200 caractères.

  `applname`

    `SQL_ATTR_INFO_APPLNAME` : un pointeur vers une chaîne de caractères utilisée pour identifier le nom de l'application du client envoyée vers le serveur de base de données lors de la connexion à DB2.

    > Note:

    > DB2 pour les serveurs z/OS et OS/390 supportent jusqu'à 32 caractères.

  `wrkstnname`

    `SQL_ATTR_INFO_WRKSTNNAME` : un pointeur vers une chaîne de caractères utilisée pour identifier le nom de la machine du client envoyée vers le serveur de base de données lors de la connexion à DB2.

    > Note:

    > DB2 pour les serveurs z/OS et OS/390 supportent jusqu'à 18 caractères.

La table suivante spécifie quelles options qui sont compatibles avec le type de ressource disponible :

Matrice ressource paramètre
Clé | Valeur | Type de ressource
--- | --- | ---
|  | Connexion | Requête | Jeu de résultats
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 | -

### Valeurs de retour

Retourne la configuration courante de la connexion fournie en cas de succès ou `false` si une erreur survient.

### Exemples

Exemple #1 Fixe et récupère les paramètres d'une ressource de connexion

`<?php
/* Paramètres de Connexion */
$database = 'SAMPLE';
$user = 'db2inst1';
$password = 'ibmdb2';
/* Récupération de la Ressource de Connexion */
$conn = db2_connect($database, $user, $password);
echo "Attributs de connexion passés avec la chaîne de caractères de connexion :\n";
/* Crée un tableau associatif d'options avec les paires clé/valeur valides */
/* Assigne les attributs à partir de la chaîne de caractères de connexion */
/* Accède les options spécifiées */
$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 "Attributs après la connexion :\n";
/* Crée un tableau associatif d'options avec les paires clé/valeur valides */
/* Assigne les attributs après que la connexion soit faite */
/* Accède les options spécifiées */
$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";
?>`

L'exemple ci-dessus va afficher :

    Attributs de connexion passés avec la chaîne de caractères de connexion :
    db2inst1
    account
    myapp
    workstation
    Attributs après la connexion :
    db2inst1
    account
    myapp
    workstation

### Voir aussi

- db2_connect() - Retourne une connexion à une base de données
- db2_cursor_type() - Retourne le type de curseur utilisé par une ressource
- db2_exec() - Exécute une requête SQL directement
- db2_set_option() - Fixe des options pour une connexion ou des ressources
- db2_pconnect() - Retourne une connexion persistante à une base de données
- db2_prepare() - Prépare une requête SQL à être exécutée