Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
mysql_stmt_attr_get(3)	      MariaDB Connector/C	mysql_stmt_attr_get(3)

   Name
       mysql_stmt_attr_get - Gets the current value of a statement attribute

   Synopsis
	      #include <mysql.h>

	      my_bool mysql_stmt_attr_get(MYSQL_STMT * stmt,
					  enum enum_stmt_attr_type,
					  void * attr);

   Description
       Gets  the current value of a statement attribute.  Returns zero on suc-
       cess, non zero on failure.

   Parameter
        stmt  -  a  statement	handle,	 which	was  previously	 allocated  by
	 mysql_stmt_init(3).

        enum_stmt_attr_type - attribute.  See below.

        attr -	pointer	to a variable, which will contain the attribute	value.

   Attribute types
       The enum_stmt_attr_type parameter has the following possible values:

       Value			 Type			    Description
       -----------------------------------------------------------------------------
       STMT_ATTR_UP-		 my_bool *		    Indicates		 if
       DATE_MAX_LENGTH					    mysql_stmt_store_re-
							    sult(3) will update	the
							    max_length	 value	 of
							    MYSQL_FIELD	structures.
       STMT_ATTR_CURSOR_TYPE	 unsigned long *	    Possible   values	are
							    CURSOR_TYPE_READ_ONLY
							    or default	value  CUR-
							    SOR_TYPE_NO_CURSOR.
       STMT_ATTR_PREFETCH_ROWS	 unsigned long *	    Number  of	rows  which
							    will   be	prefetched.
							    The	default	value is 1.
       STMT_ATTR_PRE-		 unsigned int *		    Number   of	 parameters
       BIND_PARAMS					    used     for      mari-
							    adb_stmt_execute_di-
							    rect(3)
       STMT_ATTR_STATE		 enum mysql_stmt_state *    Status    of   prepared
							    statement.	   Possible
							    values  are	 defined in
							    enum  mysql_stmt_state.
							    This  option  was added
							    in MariaDB	Connector/C
							    3.1.0

   Notes
        Setting  the  number  of prefetched rows will work only for read only
	 cursors.

   See Also
        mysql_stmt_attr_set(3)

Version	3.4						mysql_stmt_attr_get(3)

Want to link to this manual page? Use this URL:
<
https://man.freebsd.org/cgi/man.cgi?query=mysql_stmt_attr_get&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help