diff --git a/reference/sybase/functions/sybase-affected-rows.xml b/reference/sybase/functions/sybase-affected-rows.xml index d17f4d16f0..d188ba7c74 100644 --- a/reference/sybase/functions/sybase-affected-rows.xml +++ b/reference/sybase/functions/sybase-affected-rows.xml @@ -1,26 +1,49 @@ - + sybase_affected_rows - get number of affected rows in last query + Gets number of affected rows in last query Description intsybase_affected_rows - intlink_identifier + resourcelink_identifier - - Returns: The number of affected rows by the last query. - sybase_affected_rows returns the number of rows affected by the last INSERT, UPDATE or DELETE query on the server associated with the specified link identifier. If the link identifier isn't specified, the last opened link is assumed. + + + Delete-Query + + +]]> + + + The above example would produce the following output: + + + + + + This command is not effective for SELECT statements, only on statements which modify records. To retrieve the number of rows @@ -32,6 +55,9 @@ + + See also sybase_num_rows. + diff --git a/reference/sybase/functions/sybase-close.xml b/reference/sybase/functions/sybase-close.xml index e6f0c10a56..b785fb8bda 100644 --- a/reference/sybase/functions/sybase-close.xml +++ b/reference/sybase/functions/sybase-close.xml @@ -1,16 +1,16 @@ - + sybase_close - close Sybase connection + Closes a Sybase connection Description boolsybase_close - intlink_identifier + resourcelink_identifier sybase_close closes the link to a Sybase @@ -22,16 +22,19 @@ &return.success; - Note that this isn't usually necessary, as non-persistent - open links are automatically closed at the end of the script's - execution. + + Note that this isn't usually necessary, as non-persistent + open links are automatically closed at the end of the script's + execution. sybase_close will not close persistent links generated by sybase_pconnect. - See also: sybase_connect, - sybase_pconnect. + + See also + sybase_connect and + sybase_pconnect. diff --git a/reference/sybase/functions/sybase-connect.xml b/reference/sybase/functions/sybase-connect.xml index 3038dbc3ca..404159a0bf 100644 --- a/reference/sybase/functions/sybase-connect.xml +++ b/reference/sybase/functions/sybase-connect.xml @@ -1,22 +1,24 @@ - + sybase_connect - open Sybase server connection + Opens a Sybase server connection Description - intsybase_connect - stringservername - stringusername - stringpassword + resourcesybase_connect + stringservername + stringusername + stringpassword stringcharset + stringappname - Returns: A positive Sybase link identifier on success, or - &false; on error. + + Returns a positive Sybase link identifier on success, or + &false; on failure. sybase_connect establishes a connection to a @@ -29,12 +31,28 @@ new link will be established, but instead, the link identifier of the already opened link will be returned. - The link to the server will be closed as soon as the - execution of the script ends, unless it's closed earlier by - explicitly calling sybase_close. + + The link to the server will be closed as soon as the + execution of the script ends, unless it's closed earlier by + explicitly calling sybase_close. - See also sybase_pconnect, - sybase_close. + + + <function>sybase_connect</function> example + + + + + + + See also + sybase_pconnect and + sybase_close. diff --git a/reference/sybase/functions/sybase-data-seek.xml b/reference/sybase/functions/sybase-data-seek.xml index df43e9e899..8b3c51dbb0 100644 --- a/reference/sybase/functions/sybase-data-seek.xml +++ b/reference/sybase/functions/sybase-data-seek.xml @@ -1,19 +1,20 @@ - + sybase_data_seek - move internal row pointer + Moves internal row pointer Description boolsybase_data_seek - intresult_identifier + resourceresult_identifier introw_number - Returns: &true; on success, &false; on failure + + &return.success; sybase_data_seek moves the internal row @@ -21,7 +22,9 @@ identifier to pointer to the specifyed row number. The next call to sybase_fetch_row would return that row. - See also: sybase_data_seek. + + See also + sybase_fetch_row. diff --git a/reference/sybase/functions/sybase-deadlock-retry-count.xml b/reference/sybase/functions/sybase-deadlock-retry-count.xml index b25ec71da1..636d8b14f3 100644 --- a/reference/sybase/functions/sybase-deadlock-retry-count.xml +++ b/reference/sybase/functions/sybase-deadlock-retry-count.xml @@ -1,9 +1,9 @@ - + sybase_deadlock_retry_count - set the deadlock retry count + Sets the deadlock retry count Description diff --git a/reference/sybase/functions/sybase-fetch-array.xml b/reference/sybase/functions/sybase-fetch-array.xml index 64e5444e1d..c6f2b8e153 100644 --- a/reference/sybase/functions/sybase-fetch-array.xml +++ b/reference/sybase/functions/sybase-fetch-array.xml @@ -1,19 +1,20 @@ - + sybase_fetch_array - fetch row as array + Fetch row as array Description arraysybase_fetch_array - intresult + resourceresult - Returns: An array that corresponds to the fetched row, or - &false; if there are no more rows. + + Returns an array that corresponds to the fetched row, or + &false; if there are no more rows. sybase_fetch_array is an extended version of @@ -28,31 +29,30 @@ provides a significant added value. - When selecting fields with identical names (for instance, in - a join), the associative indices will have a sequential number prepended. - See the example for details. + + When selecting fields with identical names (for instance, in + a join), the associative indices will have a sequential number prepended. + See the example for details. - - Identical fieldnames - + + + Identical fieldnames + ]]> - - - The above example would produce the following output (assuming the two tables only - have each one column called "person_id"): - - + + + The above example would produce the following output (assuming the two tables only + have each one column called "person_id"): + + @@ -65,10 +65,11 @@ array(4) { int(1) } ]]> - - + + + - For further details, also see + See also sybase_fetch_row, sybase_fetch_assoc and sybase_fetch_object. diff --git a/reference/sybase/functions/sybase-fetch-assoc.xml b/reference/sybase/functions/sybase-fetch-assoc.xml index 8c09179090..9e3d265cc7 100644 --- a/reference/sybase/functions/sybase-fetch-assoc.xml +++ b/reference/sybase/functions/sybase-fetch-assoc.xml @@ -1,9 +1,9 @@ - + sybase_fetch_assoc - fetch row as associative array + Fetch a result row as an associative array Description @@ -11,8 +11,9 @@ arraysybase_fetch_assoc resourceresult - Returns: An array that corresponds to the fetched row, or - &false; if there are no more rows. + + Returns an array that corresponds to the fetched row, or + &false; if there are no more rows. sybase_fetch_assoc is a version of @@ -30,7 +31,7 @@ See also sybase_fetch_array, - sybase_fetch_object, and + sybase_fetch_object and sybase_fetch_row. diff --git a/reference/sybase/functions/sybase-fetch-field.xml b/reference/sybase/functions/sybase-fetch-field.xml index aa6485aa1f..7ada691a86 100644 --- a/reference/sybase/functions/sybase-fetch-field.xml +++ b/reference/sybase/functions/sybase-fetch-field.xml @@ -1,16 +1,16 @@ - + sybase_fetch_field - get field information + Get field information from a result Description objectsybase_fetch_field - intresult + resourceresult intfield_offset @@ -25,28 +25,36 @@ The properties of the object are: - - - - name - column name. if the column is a result of a function, this property is set to computed#N, - where #N is a serial number. - - - column_source - the table from which the column was taken - - - max_length - maximum length of the column - - - numeric - 1 if the column is numeric - - + + + + name - column name. if the column is a result of a function, this + property is set to computed#N, where #N is a serial number. + + + + + column_source - the table from which the column was taken + + + + + max_length - maximum length of the column + + + + + numeric - 1 if the column is numeric + + + + type - datatype of the column - - - + + + - See also sybase_field_seek + See also sybase_field_seek. diff --git a/reference/sybase/functions/sybase-fetch-object.xml b/reference/sybase/functions/sybase-fetch-object.xml index eb7f9218b3..ea5597a399 100644 --- a/reference/sybase/functions/sybase-fetch-object.xml +++ b/reference/sybase/functions/sybase-fetch-object.xml @@ -1,20 +1,20 @@ - + sybase_fetch_object - fetch row as object + Fetch a row as an object Description - intsybase_fetch_object - intresult + objectsybase_fetch_object + resourceresult mixedobject - Returns: An object with properties that correspond to the + Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -60,9 +60,10 @@ object(stdclass)(3) { - - <function>sybase_fetch_object</function> return as Foo - + + + <function>sybase_fetch_object</function> return as Foo + ]]> - - + + + Speed-wise, the function is identical to sybase_fetch_array, and almost as quick as sybase_fetch_row (the difference is insignificant). - See also sybase_fetch_array, and + See also + sybase_fetch_array and sybase_fetch_row. diff --git a/reference/sybase/functions/sybase-fetch-row.xml b/reference/sybase/functions/sybase-fetch-row.xml index c132707b97..2b5cf710d4 100644 --- a/reference/sybase/functions/sybase-fetch-row.xml +++ b/reference/sybase/functions/sybase-fetch-row.xml @@ -1,19 +1,19 @@ - + sybase_fetch_row - get row as enumerated array + Get a result row as an enumerated array Description arraysybase_fetch_row - intresult + resourceresult - Returns: An array that corresponds to the fetched row, or + Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -57,12 +57,12 @@ - See also: sybase_fetch_array, - sybase_fetch_assoc, - sybase_fetch_object, - sybase_data_seek, - sybase_fetch_lengths, and - sybase_result. + See also + sybase_fetch_array, + sybase_fetch_assoc, + sybase_fetch_object, + sybase_data_seek and + sybase_result. diff --git a/reference/sybase/functions/sybase-field-seek.xml b/reference/sybase/functions/sybase-field-seek.xml index 9c686323ab..d293f486b6 100644 --- a/reference/sybase/functions/sybase-field-seek.xml +++ b/reference/sybase/functions/sybase-field-seek.xml @@ -1,25 +1,30 @@ - + sybase_field_seek - set field offset + Sets field offset Description - intsybase_field_seek - intresult + boolsybase_field_seek + resourceresult intfield_offset Seeks to the specified field offset. If the next call to sybase_fetch_field won't include a field - offset, this field would be returned. - + offset, this field would be returned. + - See also: sybase_fetch_field. + &return.success; + + + See also + sybase_fetch_field. + diff --git a/reference/sybase/functions/sybase-free-result.xml b/reference/sybase/functions/sybase-free-result.xml index 4a03e11208..b4de20fe1d 100644 --- a/reference/sybase/functions/sybase-free-result.xml +++ b/reference/sybase/functions/sybase-free-result.xml @@ -1,16 +1,16 @@ - + sybase_free_result - free result memory + Frees result memory Description boolsybase_free_result - intresult + resourceresult sybase_free_result only needs to be called diff --git a/reference/sybase/functions/sybase-get-last-message.xml b/reference/sybase/functions/sybase-get-last-message.xml index d8cf2043bb..0da83abd9d 100644 --- a/reference/sybase/functions/sybase-get-last-message.xml +++ b/reference/sybase/functions/sybase-get-last-message.xml @@ -1,5 +1,5 @@ - + @@ -16,6 +16,9 @@ sybase_get_last_message returns the last message reported by the server. + + See also sybase_min_message_severity. + diff --git a/reference/sybase/functions/sybase-min-client-severity.xml b/reference/sybase/functions/sybase-min-client-severity.xml index b15c949f36..3c12dee269 100644 --- a/reference/sybase/functions/sybase-min-client-severity.xml +++ b/reference/sybase/functions/sybase-min-client-severity.xml @@ -1,5 +1,5 @@ - + @@ -23,7 +23,8 @@ - See also: sybase_min_server_severity. + See also + sybase_min_server_severity. diff --git a/reference/sybase/functions/sybase-min-error-severity.xml b/reference/sybase/functions/sybase-min-error-severity.xml index 10e90b571f..457a1fe74d 100644 --- a/reference/sybase/functions/sybase-min-error-severity.xml +++ b/reference/sybase/functions/sybase-min-error-severity.xml @@ -1,5 +1,5 @@ - + @@ -17,7 +17,8 @@ error severity level. - See also: sybase_min_message_severity. + See also + sybase_min_message_severity. diff --git a/reference/sybase/functions/sybase-min-message-severity.xml b/reference/sybase/functions/sybase-min-message-severity.xml index f8be6b7459..b2ec70b728 100644 --- a/reference/sybase/functions/sybase-min-message-severity.xml +++ b/reference/sybase/functions/sybase-min-message-severity.xml @@ -1,5 +1,5 @@ - + @@ -17,7 +17,8 @@ message severity level. - See also: sybase_min_error_severity. + See also + sybase_min_error_severity. diff --git a/reference/sybase/functions/sybase-min-server-severity.xml b/reference/sybase/functions/sybase-min-server-severity.xml index befed0e918..4aeae840bf 100644 --- a/reference/sybase/functions/sybase-min-server-severity.xml +++ b/reference/sybase/functions/sybase-min-server-severity.xml @@ -1,5 +1,5 @@ - + @@ -23,7 +23,8 @@ - See also: sybase_min_client_severity. + See also + sybase_min_client_severity. diff --git a/reference/sybase/functions/sybase-num-fields.xml b/reference/sybase/functions/sybase-num-fields.xml index 4ce4d26d75..1bd5ef1ede 100644 --- a/reference/sybase/functions/sybase-num-fields.xml +++ b/reference/sybase/functions/sybase-num-fields.xml @@ -1,26 +1,25 @@ - + sybase_num_fields - get number of fields in result + Gets the number of fields in a result set Description intsybase_num_fields - intresult + resourceresult sybase_num_fields returns the number of fields in a result set. - See also: - sybase_db_query, + See also sybase_query, - sybase_fetch_field, + sybase_fetch_field and sybase_num_rows. diff --git a/reference/sybase/functions/sybase-num-rows.xml b/reference/sybase/functions/sybase-num-rows.xml index 0243ee4b05..903e3e2ffe 100644 --- a/reference/sybase/functions/sybase-num-rows.xml +++ b/reference/sybase/functions/sybase-num-rows.xml @@ -1,16 +1,16 @@ - + sybase_num_rows - Get number of rows in result + Get number of rows in a result set Description intsybase_num_rows - intresult + resourceresult sybase_num_rows returns the number of rows @@ -18,8 +18,8 @@ See also - sybase_db_query, - sybase_query, and + sybase_num_fields, + sybase_query and sybase_fetch_row. diff --git a/reference/sybase/functions/sybase-pconnect.xml b/reference/sybase/functions/sybase-pconnect.xml index 36550e8395..994e5d7646 100644 --- a/reference/sybase/functions/sybase-pconnect.xml +++ b/reference/sybase/functions/sybase-pconnect.xml @@ -1,31 +1,35 @@ - + sybase_pconnect - open persistent Sybase connection + Open persistent Sybase connection Description - intsybase_pconnect - stringservername - stringusername - stringpassword + resourcesybase_pconnect + stringservername + stringusername + stringpassword stringcharset + stringappname - Returns: A positive Sybase persistent link identifier on success, - or &false; on error + Returns a positive Sybase persistent link identifier on success, + or &false; on error. + sybase_pconnect acts very much like - sybase_connect with two major differences. + sybase_connect with two major differences. + First, when connecting, the function would first try to find a (persistent) link that's already open with the same host, username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. + will be returned instead of opening a new connection. + Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain @@ -35,6 +39,9 @@ This type of links is therefore called 'persistent'. + + See also sybase_connect. + diff --git a/reference/sybase/functions/sybase-query.xml b/reference/sybase/functions/sybase-query.xml index a32962d3a1..0289d2d4fd 100644 --- a/reference/sybase/functions/sybase-query.xml +++ b/reference/sybase/functions/sybase-query.xml @@ -1,19 +1,20 @@ - + sybase_query - Sends Sybase query + Sends a Sybase query Description - intsybase_query + resourcesybase_query stringquery - intlink_identifier + resourcelink_identifier - Returns: A positive Sybase result identifier on success, or + + Returns a positive Sybase result identifier on success, or &false; on error. @@ -26,8 +27,7 @@ See also - sybase_db_query, - sybase_select_db, and + sybase_select_db and sybase_connect. diff --git a/reference/sybase/functions/sybase-result.xml b/reference/sybase/functions/sybase-result.xml index 72dc9641a0..39b84c6d12 100644 --- a/reference/sybase/functions/sybase-result.xml +++ b/reference/sybase/functions/sybase-result.xml @@ -1,21 +1,22 @@ - + sybase_result - get result data + Get result data Description stringsybase_result - intresult + resourceresult introw mixedfield - Returns: The contents of the cell at the row and offset in - the specified Sybase result set. + + Returns the contents of the cell at the row and offset in + the specified Sybase result set. sybase_result returns the contents of one @@ -37,7 +38,7 @@ Recommended high-performance alternatives: sybase_fetch_row, - sybase_fetch_array, and + sybase_fetch_array and sybase_fetch_object. diff --git a/reference/sybase/functions/sybase-select-db.xml b/reference/sybase/functions/sybase-select-db.xml index ff67674d84..18e0c43409 100644 --- a/reference/sybase/functions/sybase-select-db.xml +++ b/reference/sybase/functions/sybase-select-db.xml @@ -1,17 +1,17 @@ - + sybase_select_db - select Sybase database + Selects a Sybase database Description boolsybase_select_db stringdatabase_name - intlink_identifier + resourcelink_identifier sybase_select_db sets the current active @@ -22,15 +22,16 @@ called, and use it. - &return.success; + &return.success; Every subsequent call to sybase_query will be made on the active database. - See also: + + See also sybase_connect, - sybase_pconnect, and + sybase_pconnect and sybase_query diff --git a/reference/sybase/functions/sybase-set-message-handler.xml b/reference/sybase/functions/sybase-set-message-handler.xml index 2e0b9bd642..0c5d1e367b 100644 --- a/reference/sybase/functions/sybase-set-message-handler.xml +++ b/reference/sybase/functions/sybase-set-message-handler.xml @@ -1,9 +1,9 @@ - + sybase_set_message_handler - set handler called when a server message is raised + Sets the handler called when a server message is raised Description @@ -18,17 +18,18 @@ method name. - The handler expects five arguments in the following order: message - number, severity, state, line number and description. The first four are - integers. The last is a string. If the function returns &false;, PHP - generates an ordinary error message. + The handler expects five arguments in the following order: message + number, severity, state, line number and description. The first four are + integers. The last is a string. If the function returns &false;, PHP + generates an ordinary error message. &return.success; - - <function>sybase_set_message_handler</function> callback function - + + + <function>sybase_set_message_handler</function> callback function + ]]> - - - - <function>sybase_set_message_handler</function> callback to a class - + + + + <function>sybase_set_message_handler</function> callback to a class + ]]> - - - - <function>sybase_set_message_handler</function> unhandled messages - + + + + <function>sybase_set_message_handler</function> unhandled messages + ]]> - - + + + diff --git a/reference/sybase/functions/sybase-unbuffered-query.xml b/reference/sybase/functions/sybase-unbuffered-query.xml index 53daa68f9d..ba6aaf5ae7 100644 --- a/reference/sybase/functions/sybase-unbuffered-query.xml +++ b/reference/sybase/functions/sybase-unbuffered-query.xml @@ -1,19 +1,20 @@ - + sybase_unbuffered_query - send Sybase query and do not block + Send a Sybase query and do not block Description resourcesybase_unbuffered_query stringquery - intlink_identifier + resourcelink_identifier - Returns: A positive Sybase result identifier on success, or - &false; on error. + + Returns a positive Sybase result identifier on success, or + &false; on error. sybase_unbuffered_query sends a query to the @@ -49,9 +50,10 @@ the resultsets should'nt be fetched into memory, thus minimizing memory usage which is particularily interesting with very large resultsets. - - <function>sybase_unbuffered_query</function> - + + + <function>sybase_unbuffered_query</function> example + ]]> - - + + +