--- postgresql-7.0.3/doc/src/sgml/libpq++.sgml Tue May 2 22:01:51 2000 +++ postgresql-7.0.3-jtv/doc/src/sgml/libpq++.sgml Mon Feb 26 15:17:14 2001 @@ -354,7 +354,7 @@ Tuples Returns the number of tuples (instances) in the query result. - int PgDatabase::Tuples() + int PgDatabase::Tuples() const @@ -364,7 +364,7 @@ Returns the number of rows affected after an INSERT, UPDATE or DELETE. If the command was anything else, it returns -1. - int PgDatabase::CmdTuples() + int PgDatabase::CmdTuples() const @@ -383,7 +383,7 @@ Returns the field (attribute) name associated with the given field index. Field indices start at 0. - const char *PgDatabase::FieldName(int field_num) + const char *PgDatabase::FieldName(int field_num) const @@ -393,7 +393,7 @@ PQfnumber Returns the field (attribute) index associated with the given field name. - int PgDatabase::FieldNum(const char* field_name) + int PgDatabase::FieldNum(const char* field_name) const -1 is returned if the given name does not match any field. @@ -405,7 +405,7 @@ integer returned is an internal coding of the type. Field indices start at 0. - Oid PgDatabase::FieldType(int field_num) + Oid PgDatabase::FieldType(int field_num) const @@ -416,7 +416,7 @@ integer returned is an internal coding of the type. Field indices start at 0. - Oid PgDatabase::FieldType(const char* field_name) + Oid PgDatabase::FieldType(const char* field_name) const @@ -426,7 +426,7 @@ Returns the size in bytes of the field associated with the given field index. Field indices start at 0. - short PgDatabase::FieldSize(int field_num) + short PgDatabase::FieldSize(int field_num) const Returns the space allocated for this field in a database tuple given the field number. In other words the size of the server's binary @@ -440,7 +440,7 @@ Returns the size in bytes of the field associated with the given field index. Field indices start at 0. - short PgDatabase::FieldSize(const char *field_name) + short PgDatabase::FieldSize(const char *field_name) const Returns the space allocated for this field in a database tuple given the field name. In other words the size of the server's binary @@ -454,7 +454,7 @@ Returns a single field (attribute) value of one tuple of a PGresult. Tuple and field indices start at 0. - const char *PgDatabase::GetValue(int tup_num, int field_num) + const char *PgDatabase::GetValue(int tup_num, int field_num) const For most queries, the value returned by GetValue is a null-terminated ASCII string representation of the attribute value. But if BinaryTuples() @@ -474,7 +474,7 @@ Returns a single field (attribute) value of one tuple of a PGresult. Tuple and field indices start at 0. - const char *PgDatabase::GetValue(int tup_num, const char *field_name) + const char *PgDatabase::GetValue(int tup_num, const char *field_name) const For most queries, the value returned by GetValue is a null-terminated ASCII string representation of the attribute value. But if BinaryTuples() @@ -490,11 +490,33 @@ + GetIsNull + Returns whether a field has the null value. + + bool GetIsNull(int tup_num, int field_num) const + + Note that GetValue will return the empty string for null fields, not + the NULL pointer. + + + + + GetIsNull + Returns whether a field has the null value. + + bool GetIsNull(int tup_num, const char* field_name) const + + Note that GetValue will return the empty string for null fields, not + the NULL pointer. + + + + GetLength Returns the length of a field (attribute) in bytes. Tuple and field indices start at 0. - int PgDatabase::GetLength(int tup_num, int field_num) + int PgDatabase::GetLength(int tup_num, int field_num) const This is the actual data length for the particular data value, that is the size of the object pointed to by GetValue. Note that for @@ -508,7 +530,7 @@ Returns the length of a field (attribute) in bytes. Tuple and field indices start at 0. - int PgDatabase::GetLength(int tup_num, const char* field_name) + int PgDatabase::GetLength(int tup_num, const char* field_name) const This is the actual data length for the particular data value, that is the size of the object pointed to by GetValue. Note that for @@ -522,8 +544,8 @@ Prints out all the tuples and, optionally, the attribute names to the specified output stream. - void PgDatabase::DisplayTuples(FILE *out = 0, int fillAlign = 1, - const char* fieldSep = "|",int printHeader = 1, int quiet = 0) + void PgDatabase::DisplayTuples(FILE *out = 0, bool fillAlign = true, + const char* fieldSep = "|",bool printHeader = true, bool quiet = false) const @@ -533,8 +555,8 @@ Prints out all the tuples and, optionally, the attribute names to the specified output stream. - void PgDatabase::PrintTuples(FILE *out = 0, int printAttName = 1, - int terseOutput = 0, int width = 0) + void PgDatabase::PrintTuples(FILE *out = 0, bool printAttName = true, + bool terseOutput = false, bool fillAlign = false) const @@ -558,7 +580,7 @@ OidStatus - const char *PgDatabase::OidStatus() + const char *PgDatabase::OidStatus() const @@ -612,8 +634,8 @@ to see if any notification data is currently available from the backend. PgDatabase::Notifies returns the notification from a list of unhandled notifications from the - backend. The function eturns NULL if there is no pending notifications from the - backend. + backend. The function returns NULL if there is no pending notifications + from the backend. PgDatabase::Notifies behaves like the popping of a stack. Once a notification is returned from PgDatabase::Notifies,