odbc_setoption

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_setoptionModifie les paramètres ODBC

Description

odbc_setoption(
    Odbc\Connection|Odbc\Result $odbc,
    int $which,
    int $option,
    int $value
): bool

odbc_setoption() donne accès aux options ODBC pour une connexion particulière ou un résultat de requête. Elle a été écrite pour aider à la résolution de problèmes liés aux pilotes ODBC récalcitrants. Il sera sûrement à utiliser odbc_setoption() en tant que programmeur ODBC comprenant les divers effets des options disponibles. Il sera aussi besoin d'un bon manuel de référence pour comprendre les options et leur usage. Différentes versions de pilotes supportent différentes versions d'options.

Étant donné que les effets peuvent varier d'un pilote à l'autre, l'utilisation de odbc_setoption() dans des scripts voués à être livrés au public est très fortement déconseillée. De plus, certaines options ODBC ne sont pas disponibles car elles doivent être fixées avant l'établissement de la connexion. Cependant, si dans un cas bien spécifique, odbc_setoption() permet d'utiliser PHP sans qu'il soit nécessaire de recourir à utiliser un produit commercial, alors cela n'a pas d'importance.

Liste de paramètres

odbc

Un identifiant de connexion, ou un identifiant de résultat, pour lequel il faut modifier des options. Pour SQLSetConnectOption(), c'est un identifiant de connexion. Pour SQLSetStmtOption(), c'est un identifiant de résultat.

which

Fonction ODBC à utiliser. La valeur doit être de 1 pour utiliser SQLSetConnectOption() et 2 pour SQLSetStmtOption().

option

L'option à définir.

value

La valeur pour l'option donnée.

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Historique

Version Description
8.4.0 odbc attend désormais une instance de Odbc\Connection ou de Odbc\Result; auparavant, une resource était attendue.

Exemples

Exemple #1 Exemple avec odbc_setoption()

<?php
// 1. L'option 102 de SQLSetConnectOption() est SQL_AUTOCOMMIT.
// 1 de SQL_AUTOCOMMIT est SQL_AUTOCOMMIT_ON.
// Cet exemple a le même effet que
// odbc_autocommit($conn, true);

odbc_setoption($conn, 1, 102, 1);

// 2. Option 0 de SQLSetStmtOption() est SQL_QUERY_TIMEOUT.
// Cet exemple fixe le délai d'expiration à 30 secondes.

$result = odbc_prepare($conn, $sql);
odbc_setoption($result, 2, 0, 30);
odbc_execute($result);
?>