---

CMyMySQLPPField Class Reference

#include <MyMySQLPPField.h>

---

Detailed Description

The field object reflects the structure of a field.

Definition at line 28 of file MyMySQLPPField.h.

Public Member Functions
	CMyMySQLPPField (void)
	Class constructor.
	CMyMySQLPPField (MYSQL_FIELD *field)
	Class constructor accepting a field pointer.
	~CMyMySQLPPField (void)
	Class destructor.
void	Attach (MYSQL_FIELD *field)
	Attaches a field object.
void	Free (void)
	Resets internal field pointer.
char *	GetName (void)
	The name of the field, as a null-terminated string.
char *	GetTable (void)
	The name of the table containing this field, if it isn't a calculated field. For calculated fields, the returned value is an empty string.
char *	GetDefaultValue (void)
	The default value of this field, as a null-terminated string. This is set only if you use CMyMySQLPPConnection::ListFields.
enum enum_field_types	GetType (void)
	The type of the field.
char *	GetTypeString (void)
	The type of the field as string.

---

Constructor & Destructor Documentation

CMyMySQLPPField::CMyMySQLPPField (  void    )

Class constructor. Definition at line 32 of file MyMySQLPPField.cpp.

CMyMySQLPPField::CMyMySQLPPField (  MYSQL_FIELD *    field )

Class constructor accepting a field pointer. Parameters: field  Field to attach Definition at line 40 of file MyMySQLPPField.cpp. References Attach().

CMyMySQLPPField::~CMyMySQLPPField (  void    )

Class destructor. Definition at line 47 of file MyMySQLPPField.cpp. References Free().

---

Member Function Documentation

void CMyMySQLPPField::Attach (  MYSQL_FIELD *    field )

Attaches a field object. Parameters: field  Field to attach Definition at line 55 of file MyMySQLPPField.cpp. Referenced by CMyMySQLPPField(), and CMyMySQLPPResult::FetchField().

void CMyMySQLPPField::Free (  void    )

Resets internal field pointer. Definition at line 61 of file MyMySQLPPField.cpp. Referenced by CMyMySQLPPResult::FetchField(), and ~CMyMySQLPPField().

char * CMyMySQLPPField::GetDefaultValue (  void    )

The default value of this field, as a null-terminated string. This is set only if you use CMyMySQLPPConnection::ListFields. Returns: Default value for this field Definition at line 85 of file MyMySQLPPField.cpp.

char * CMyMySQLPPField::GetName (  void    )

The name of the field, as a null-terminated string. Returns: Name of field Definition at line 69 of file MyMySQLPPField.cpp.

char * CMyMySQLPPField::GetTable (  void    )

The name of the table containing this field, if it isn't a calculated field. For calculated fields, the returned value is an empty string. Returns: Name of table or an empty string if it's a calculated field. Definition at line 77 of file MyMySQLPPField.cpp.

enum enum_field_types CMyMySQLPPField::GetType (  void    )

The type of the field. Returns: Type of this field Definition at line 93 of file MyMySQLPPField.cpp. Referenced by GetTypeString().

char * CMyMySQLPPField::GetTypeString (  void    )

The type of the field as string. Returns: String describing type of this field Definition at line 101 of file MyMySQLPPField.cpp. References GetType().

---

The documentation for this class was generated from the following files:

• MyMySQLPPField.h
• MyMySQLPPField.cpp

---