fielddef 構造体

フィールド定義構造体 [詳解]

#include <tdapSchema.h>

fielddef の継承関係図

公開メンバ関数
int	align () const
uint_td	blobDataLen (const uchar_td *ptr) const
uint_td	blobLenBytes () const
const char *	chainChar () const
unsigned int	charNum () const
uchar_td	charsetIndex () const
unsigned int	codePage () const
uint_td	dataLen (const uchar_td *ptr) const
bool	isBlob () const
bool	isNumericType () const
bool	isStringType () const
const uchar_td *	keyData (const uchar_td *ptr) const
uint_td	keyDataLen (const uchar_td *ptr) const
int	maxVarDatalen () const
const char *	name () const
const char *	name (char *buf) const
const char *	nameA () const
void	setChainChar (const char *s)
void	setCharsetIndex (uchar_td index)
void	setLenByCharnum (ushort_td charnum)
void	setName (const char *s)
void	setNameA (const char *s)
void	setPadCharSettings (bool set, bool trim)
bool	trimPadChar () const
const _TCHAR *	typeName () const
bool	usePadChar () const
int	varLenBytes () const

その他の継承メンバ
基底クラス fielddef_t< N > に属する継承公開変数類
ushort_td	ddfid
uchar_td	decimals
double	defValue
ushort_td	defViewWidth
FLAGS	enableFlags
ushort_td	filterId
uchar_td	filterKeynum
ushort_td	keylen
ushort_td	len
uchar_td	lookDBNum
uchar_td	lookField
uchar_td	lookFields [3]
uchar_td	lookTable
double	max
double	min
uchar_td	nullValue
ushort_td	pos
uchar_td	type
ushort_td	userOption
char	viewNum
ushort_td	viewWidth
基底クラス fielddef_t< N > に属する継承限定公開変数類
char	m_chainChar [2]
uchar_td	m_charsetIndex
char	m_name [N]
ushort_td	m_padCharOptions
ushort_td	m_schemaCodePage

詳解

フィールド定義構造体

関数詳解

int align ( ) const

inline

フィールドタイプの表示上のアライメントを返します。

戻り値

0 or 1 or 2 を返します。それぞれ左揃え、中央揃え、右揃えです。

uint_td blobDataLen ( const uchar_td *  ptr ) const

inline

BLOBフィールドの内容の長さを返します。 内容の長さを保持する領域分は除外されます。

引数

ptr	データバッファ内のこのフィールドの先頭アドレスを指定します。

uint_td blobLenBytes ( ) const

inline

BLOB型の内容の長さを示す領域のサイズをバイト数で返します。 BLOB型で無い場合は0を返します。

const char * chainChar

(

)

const

don't use. BizStation internal use only.

マルチバイトコンパイル時のみ

unsigned int charNum

(

)

const

フィールドの最大文字数を返します。 文字数の計算はlenをcharsetIndexで指定された文字コードの１文字当たりのバイト数で割った値です。 フィールドがchar型とvarchar型以外の時は、lenをそのまま返します。

uchar_td charsetIndex ( ) const

inline

指定されたキャラクターセットをインデックス番号で返します。

unsigned int codePage ( ) const

inline

このフィールドのコードページを返します。

uint_td dataLen ( const uchar_td *  ptr ) const

inline

フィールドの内容の長さを返します。 内容の長さを保持する領域分は除外されます。

引数

ptr	データバッファ内のこのフィールドの先頭アドレスを指定します。

bool isBlob ( ) const

inline

フィールドがft_myblobまはたft_mytextかどうかを返します。

bool isNumericType ( ) const

inline

フィールドが数値(通貨も含む)を返すタイプかどうかを返します。

bool isStringType

(

)

const

フィールドが文字列を保持するタイプかどうかを返します。 string char blob text noteなどはstring typeです。

const uchar_td * keyData ( const uchar_td *  ptr ) const

inline

このフィールドの値をキーバッファにコピーする際の値を取得します。

uint_td keyDataLen ( const uchar_td *  ptr ) const

inline

このフィールドの値をキーバッファにコピーする際のデータの長さを取得します。

int maxVarDatalen ( ) const

inline

可変サイズのフィールドで保持できる最大データサイズを返します。可変サイズでない場合はゼロを返します。

const char * name

(

)

const

フィールド名を返します。

UNICODEコンパイル時のみ

フィールド名を取得します。 マルチバイトコンパイル時のみ

const char * name

(

char *

buf

)

const

bufで指定したバッファにフィールド名をコピーして返します。 bufのサイズはMYSQL_FDNAME_SIZE + 1以上でなければなりません。

const char * nameA ( ) const

inline

フィールド名を取得します。

void setChainChar

(

const char *

s

)

don't use. BizStation internal use only.

UNICODEコンパイル時のみ

don't use. BizStation internal use only.

マルチバイトコンパイル時のみ

void setCharsetIndex ( uchar_td  index )

inline

キャラクターセットをインデックス番号で指定します。 何も指定しないかった場合は、テーブルに設定されたキャラクターセットがコピーされます。 コードページからインデックスへの変換は mysql::charsetIndex(unsigned short codePage) で行えます。

void setLenByCharnum ( ushort_td  charnum )

inline

フィールドタイプがft_mychar ft_myvarchar ft_mywchar ft_mywvarchar型 の場合に、charnumで指定した文字数から、 setCharsetIndex()で指定された文字コード を使って、 len を計算してセットします。 前記以外のフィールドタイプの場合は、lenにcharnumをそのままセットします。

void setName

(

const char *

s

)

フィールド名をセットします。

UNICODEコンパイル時のみ

フィールド名をセットします。

マルチバイトコンパイル時のみ

void setNameA ( const char *  s )

inline

フィールド名をセットします。

void setPadCharSettings ( bool  set, bool  trim  )

inline

ft_string ft_wstringフィールドタイプにおいて空白のセットと取り除きについて設定します。

引数

set	値の設定時に文字列の長さがフィールド長より短い場合、余剰部分を空白で埋めるかかどうかを返します。 trueの場合空白で埋めます。falseの場合は特別な処理は行いません。
trim	値の取得時に空白を自動で取り除いて返すかどうかを指定します。

bool trimPadChar ( ) const

inline

ft_string ft_wstringフィールドタイプの値の取得時に、空白を自動で取り除いて返すかどうかを返します。

const _TCHAR * typeName ( ) const

inline

フィールドタイプの名前を取得します。

bool usePadChar ( ) const

inline

ft_string ft_wstringフィールドタイプの値の設定において、文字列の長さがフィールド長より短い場合、余剰部分を空白で埋めるかかどうかを返します。

int varLenBytes ( ) const

inline

文字列型の文字列長を示す領域のサイズをバイト数で返します。 可変長で無い場合は0を返します。