この節では、ユーティリティー関数、その形式、使用法、 およびパラメーターのそれぞれを説明するとともに、簡単な例を記載します。
使用法
dtw_malloc() を用いて Net.Data の実行時ヒープから割り当てた記憶域を解放します。 buffer は、解放する割り当て済み記憶域を指します。
構文
void dtw_free(void *buffer)
パラメーター
buffer | 解放する割り当て済み記憶域へのポインター。 |
例
char *myBuf; long nbytes = 8192; myBuf = (char *)dtw_malloc(nbytes); dtw_free((void *)myBuf);
使用法
Net.Data 初期設定ファイルから var_name が指定した構成変数の値を取り出します。 Net.Data は、dtw_getvar() から戻されたメモリーを所有しますが、その変更も解放も行いません。
構文
char *dtw_getvar(char *var_name)
パラメーター
var_name | 取り出す構成変数の名前。 |
例
char *myBindFile; myBindFile = dtw_getvar("BIND_FILE");
使用法
dtw_malloc() を用いて、Net.Data の実行時ヒープから割り当てた記憶域を指し示すポインターを戻します。 記憶域の長さは、nbytes です。 Net.Data は、要求された記憶域を戻せない場合は、NULL ポインターを戻します。
構文
void *dtw_malloc(long nbytes)
パラメーター
nbytes | 割り当てるバイトの数。 |
例
char *myBuf; long nbytes = 8192; myBuf = (char *)dtw_malloc(nbytes);
使用法
行の幅を割り当て、列見出しの記憶域を割り当てます。 dtw_row_SetCols() ユーティリティー関数は、行ごとに 1 回使用することができます。
構文
int dtw_row_SetCols(void *row, int cols)
パラメーター
row | まだ列が割り当てられていない、新たに作成された行へのポインター。 |
cols | 新しい行に割り当てる列数の初期値。 |
例
void *myRow; rc = dtw_row_SetCols(myRow, 5);
使用法
表値を割り当てます。 dtw_row_SetV() ユーティリティー関数の呼び出し側は、src が指し示すメモリーの所有権を保存します。 現行表値を削除する場合は、この値を NULL に割り当てます。
構文
int dtw_row_SetV(void *row, char *src, int col)
パラメーター
row | 修正する行へのポインター。 |
src | 設定する新しい値が入っている文字列。 |
col | 設定する値の列番号。 |
例
void *myTable; char *myFieldValue = "newValue"; rc = dtw_row_SetV(myRow, myFieldValue, 3);
使用法
dtw_malloc() を用いて、Net.Data の実行時ヒープから記憶域を割り当て、string により指定されたストリングを、割り当てた記憶域にコピーします。 Net.Data は、要求された記憶域を戻せない場合は、NULL ポインターを戻します。
構文
char *dtw_strdup(char *string)
パラメーター
string | 割り当て済み記憶域に複写する文字列値へのポインター。 |
例
char *myString = "This string will be duplicated."; char *myDupString; myDupString = dtw_strdup(myString);
使用法
表の終わりに 1 つまたは複数の行を追加します。 表に数行追加した後、dtw_table_SetV() ユーティリティーで新しい行の表値を割り当てます。
構文
int dtw_table_AppendRow(void *table, int rows)
パラメーター
table | 追加が行われる表へのポインター。 |
rows | 追加される行の数。 |
例
void *myTable; rc = dtw_table_AppendRow(myTable, 10);
使用法
表内の現在の列数を戻します。
構文
int dtw_table_Cols(void *table)
パラメーター
table | 現在の列数が戻される表へのポインター。 |
例
void *myTable; int currentColumns; currentColumns = dtw_table_Cols(myTable);
使用法
列見出し、表値、および表オブジェクトのすべてを削除します。
構文
int dtw_table_Delete(void *table)
パラメーター
table | 削除する表へのポインター。 |
例
void *myTable; rc = dtw_table_Delete(myTable);
使用法
start_col で指定された列から始まる 1 つまたは複数の列を削除します。 表の行と列をすべて削除する場合は、cols パラメーターに代えてユーティリティー関数 dtw_table_Cols() を使用します。
dtw_table_DeleteCol(table, 1, dtw_table_Cols());
構文
int dtw_table_DeleteCol(void *table, int start_col, int cols)
パラメーター
table | 修正する表へのポインター。 |
start_col | 削除する最初の列の列番号。 |
rows | 削除する列の数。 |
例
void *myTable; rc = dtw_table_DeleteCol(myTable, 1, 10);
使用法
start_rowで指定された列から始まる 1 つまたは複数の行を削除します。
構文
int dtw_table_DeleteRow(void *table, int start_row, int rows)
パラメーター
table | 修正する表へのポインター。 |
start_row | 削除する最初の行の行番号。 |
rows | 削除する行の数。 |
例
void *myTable; rc = dtw_table_DeleteRow(myTable, 3, 10);
使用法
列見出しを取り出します。 Net.Data は、dest が指し示すメモリーを所有しますが、その変更も解放も行いません。
構文
int dtw_table_GetN(void *table, char **dest, int col)
パラメーター
table | 列見出しが取り出される表へのポインター。 |
dest | 列見出しが入る文字列へのポインター。 |
col | 列見出しの列番号。 |
例
void *myTable; char *myColumnHeading; rc = dtw_table_GetN(myTable, &myColumnHeading, 5);
使用法
表から値を取り出します。 Net.Data は、dest が指し示すメモリーを所有しますが、その変更も解放も行いません。
構文
int dtw_table_GetV(void *table, char **dest, int row, int col)
パラメーター
table | 値が取り出される表へのポインター。 |
dest | 値を含む文字ストリングを指し示すポインター。 |
row | 取り出す値の行番号。 |
col | 取り出す値の列番号。 |
例
void *myTable; char *myTableValue; rc = dtw_table_GetV(myTable, &myTableValue, 3, 5);
使用法
指定された列の後に 1 つまたは複数の列を挿入します。
構文
int dtw_table_InsertCol(void *table, int after_col, int cols)
パラメーター
table | 修正する表へのポインター。 |
after_col | 新しい列が挿入される列の番号 (この列の後に挿入されます)。 この表の始めに列を挿入する場合は、0 を指定します。 |
cols | 挿入する列の数。 |
例
void *myTable; rc = dtw_table_InsertCol(myTable, 3, 10);
使用法
指定された行の後に 1 つまたは複数の行を挿入します。
構文
int dtw_table_InsertRow(void *table, int after_row, int rows)
パラメーター
table | 修正する表へのポインター。 |
after_row | 新しい行が挿入される行の番号 (この行の後に挿入されます)。 この表の始めに行を挿入する場合は、0 を指定します。 |
rows | 挿入する行の数。 |
例
void *myTable; rc = dtw_table_InsertRow(myTable, 3, 10);
使用法
dtw_table_New() ユーティリティー関数パラメーター row_limで定義されると、Net.Data 表に許可された行の最大数を戻します。
構文
int dtw_table_MaxRows(void *table)
パラメーター
table | 行の最大数が戻される元の表を指し示すポインター。 |
例
void *myTable; int maximumRows; maximumRows = dtw_table_MaxRows(myTable);
使用法
Net.Data 表オブジェクトを作成し、すべての列見出しおよびフィールド値を NULL に初期化します。 呼び出し側が、行数と列数の初期値および行の最大数を指定します。 行および列の初期数が 0 の場合は、表関数呼び出しの前に、dtw_table_SetCols() 関数を用いて行内のフィールド数を指定しなければなりません。
構文
int dtw_table_New(void **table, int rows, int cols, int row_lim)
パラメーター
table | 新しい表の名前。 |
rows | 新しい表に割り当てる行数の初期値。 |
cols | 新しい表に割り当てる列の初期数。 |
row_lim | この表に含めることができる行の最大数。 |
例
void *myTable; rc = dtw_table_New(&myTable, 20, 5, 100);
使用法
列見出しに関連する列番号を戻します。
構文
int dtw_table_QueryColnoNj(void *table, char *name)
パラメーター
table | 照会する表へのポインター。 |
name | 列番号が戻される列見出しを指定する文字列。 その列見出しが表に存在しない場合には、0 が戻されます。 |
例
void *myTable; int columnNumber; columnNumber = dtw_table_QueryColnoNj(myTable, "column 1");
使用法
表内の現在の行数を戻します。
構文
int dtw_table_Rows(void *table)
パラメーター
table | 現在の行数が戻される表へのポインター。 |
例
void *myTable; int currentRows; currentRows = dtw_table_Rows(myTable);
使用法
表の列数を設定し、列見出し用の記憶域を割り当てます。 列見出しを表の作成時に指定します。表の作成時に指定しない場合は、 他の表関数を使用する前に、このユーティリティー関数を呼び出して指定しなければなりません。 dtw_table_SetCols() ユーティリティー関数を使用できるのは、1 つの表につき 1 回だけです。 その後は、dtw_table_DeleteCol() ユーティリティー関数または dtw_table_InsertCol() ユーティリティー関数を使用してください。
構文
int dtw_table_SetCols(void *table, int cols)
パラメーター
table | 列または行が割り当てられていない新しい表へのポイン ター。 |
cols | 新しい表に割り当てる列の初期数。 |
例
void *myTable; rc = dtw_table_SetCols(myTable, 5);
使用法
列見出しに名前を割り当てます。 dtw_table_SetN() ユーティリティー関数の呼び出し側が、srcパラメーターが指し示すメモリーの所有権を保存します。 列見出しを削除する場合は、列見出し値を NULL に割り当てます。
構文
int dtw_table_SetN(void *table, char *src, int col)
パラメーター
table | 列見出しが割り当てられる表を指し示すポインター。 |
src | 新しい列見出しに割り当てられる文字ストリング。 |
col | 列の番号。 |
例
void *myTable; char *myColumnHeading = "newColumnHeading"; rc = dtw_table_SetN(myTable, myColumnHeading, 5);
使用法
表内の値を割り当てます。 dtw_table_SetV() ユーティリティー関数の呼び出し側が、srcパラメーターが指し示すメモリーの所有権を保存します。 表値を削除する場合は、この値を NULL に割り当てます。
構文
int dtw_table_SetV(void *table, char *src, int row, int col)
パラメーター
table | 値が割り当てられる表を指し示すポインター。 |
src | 新しい値に割り当てられる文字ストリング。 |
row | 新しい値の行番号。 |
col | 新しい値の列番号。 |
例
void *myTable; char *myTableValue = "newValue"; rc = dtw_table_SetV(myTable, myTableValue, 3, 5);