Description
Retrieves a Query property.
Syntax
flag = QryGetProperty (hQry, property, value, arg)
Parameters
The QryGetProperty function has the following parameters:
| Parameter | Description |
|---|---|
| hQry | Handle to a Connection Object returned by XOInstance. |
| property | See properties below. |
| value | Property specific; see Properties below. |
| arg | Property specific; see Properties below. |
| Property | Description |
|---|---|
| QRY_COLCOUNT$ | Returns the number of columns in the result set. value [out] Count of columns in result set. hQry [in] Query handle. |
| QRY_COLDESCRIPT$ | Returns the specified column's name, type, precision, scale, nullability, and OI type. value [out] Column name, type, precision, scale, and nullability and OI type delimited by field marks. hQry [in] Query handle. arg [in] Column number |
| QRY_COLOITYPE$ | Returns the specified column's OI type. value [out] OI type. hQry [in] Query handle. arg [in] Column number |
| QRY_COLNAME$ | Returns the specified column's name. value [out] Column name. hQry [in] Query handle. arg [in] Column number |
| QRY_COLNULLABLE$ | Returns the specified column's nullability. value [out] Nullable flag. hQry [in] Query handle. arg [in] Column number |
| QRY_COLPRECISION$ | Returns the specified column's precision. value [out] Column precision. hQry [in] Query handle. arg [in] column number |
| QRY_COLSCALE$ | Returns the specified column's scale. value [out] Column scale. hQry [in] Query handle. arg [in] Column number |
| QRY_COLTYPE$ | Returns the specified column's type. value [out] Column type. hQry [in] Query handle. arg [in] Column number |
| QRY_CONNECTION$ | Returns the Connection Object handle which the query uses. value [out] Connection Object handle (hXO) for the query. hQry [in] Query handle. |
| QRY_ROWCOUNT$ | Returns the number of rows in the result set. value [out] Count of rows in result set. hQry [in] Query handle. Note: The number of rows returned may be -1, signifying that the Connection Object does not know how many rows are in the result set, or it may be the number of rows retrieved so far, or it may actually be the number of rows in the result set; the behavior is specific to the Connection Object. |
| QRY_TIMEOUT$ | Returns the query timeout. For QrySetProperty, QRY_TMEOUT$ sets the query timeout. hQry [in] Query handle. value [out] Timeout in seconds. |
| QRY_VALID$ | Checks if the passed Query handle is valid. value [out] TRUE$ if the passed Query handle is valid. hQry [in] Query handle. |
Remarks
Column parameters can to be either name or position (number). In addition, QryGetProperty supports @VM lists of column names/positions to be passed or 0 to signify all.
Returns
True for successful execution or False for failure.
