PDOStatement::getAttribute

DownloadDownload PHP Driver

Retrieves the value of a predefined PDOStatement attribute or custom driver attribute.

Syntax


mixed PDOStatement::getAttribute( $attribute );  

Parameters

$attribute: An integer, one of the PDO::ATTR_* or PDO::SQLSRV_ATTR_* constants. Supported attributes are the attributes you can set with PDOStatement::setAttribute, PDO::SQLSRV_ATTR_DIRECT_QUERY (for more information, see Direct Statement Execution and Prepared Statement Execution in the PDO_SQLSRV Driver), PDO::ATTR_CURSOR and PDO::SQLSRV_ATTR_CURSOR_SCROLL_TYPE (for more information, see Cursor Types (PDO_SQLSRV Driver)).

Return Value

On success, returns a (mixed) value for a predefined PDO attribute or custom driver attribute. Returns null on failure.

Remarks

See PDOStatement::setAttribute for a sample.

Support for PDO was added in version 2.0 of the Microsoft Drivers for PHP for SQL Server.

See Also

PDOStatement Class
PDO