2.5.1 AsisSetEnvironment

機能

Data Effectorの環境パラメタを設定します。
Data Effectorの環境パラメタは、指定したハンドルを用いて実行するData Effectorの関数の処理にだけ影響します。

記述形式

#include "libAsis.h"                /* 公開ヘッダ    */

int AsisSetEnvironment(
    ASISHANDLE      Handle,         /* ハンドル      */
    const char      *Name,          /* Data Effectorの環境パラメタ名   */
    const char      *Value          /* Data Effectorの環境パラメタの値 */
);

パラメタ

データ型	パラメタ	用途	説明
ASISHANDLE	Handle	入力	ハンドルを指定します。
const char*	Name	入力	Data Effectorの環境パラメタの名前を指定します。
const char*	Value	入力	Nameパラメタに指定したData Effectorの環境パラメタに対する値を指定します。

Name

Name には、以下の文字列が指定できます。

環境パラメタ名	意味	機能名
環境パラメタ名	意味	抽出機能	連結機能	集計機能	ソート機能
FieldSeparator	入力ファイルがCSV形式の場合、項目間の区切り文字を指定します。	○	○	○	○
FieldSeparatorMode	入力ファイルがCSV形式の場合、項目間の区切り文字の扱いを指定します。	○	○	○	○
SubstituteZeroForEmpty	数値演算式における空の扱いを指定します。	―	○	○	○(注)
QuotationMarkMode	CSV形式の結果データ中の文字列に対して、二重引用符(")の設定を指定します。	○	○	○	○(注)
SkipHeader	入力ファイルの先頭行を読みとばすかどうかを指定します。	○	○	○	○
MstSkipHeader	マスタファイルの先頭行を読みとばすかどうかを指定します。	―	○	―	―
OutputGroupItem	グループ式に指定された項目を出力するかどうかを指定します。	―	―	○	―
JoinAlert	入力マスタファイルのレコードと結合されなかった入力ジャーナルファイルのレコードが存在した場合の復帰の扱いを指定します。	―	○	―	―
OutLineFeedCode	出力データでのレコードの終端の改行コードの取り扱いを指定します。	○	○	○	○
ExceptRecordFolder	連結結果ファイルに出力されなかったレコードを指定したディレクトリ配下に出力します。入力ファイルごとにファイルを作成し、出力します。	―	○	―	―

○：指定可能
―：指定無効
注) キー仕分け機能(AsisExecuteKeySort関数)を使用する場合、本環境パラメタは無効です。

Value

Valueには、環境パラメタ名(Name)それぞれについて以下の文字列が指定できます。

注意

いずれのValueも、設定値を二重引用符(")で囲んで指定します。

FieldSeparator

入力ファイルタイプがCSVの場合、項目間の区切り文字を指定します。
本パラメタを省略した場合、カンマが指定されたものとみなします。

設定値	意味
\,	項目間の区切り文字としてカンマを使用します。
\s	項目間の区切り文字として半角空白を使用します。
\t	項目間の区切り文字として水平タブを使用します。

区切り文字として複数指定する場合は、個々の文字列をカンマ(,)で区切って指定します。

注意

本パラメタを指定した場合の出力時の区切り文字は、リターン式または集計式の指定によって、以下のように異なります。

リターン式または集計式	出力時の区切り文字
指定あり	カンマ
指定なし	入力ファイルと同じ形式

FieldSeparatorMode

入力ファイルタイプがCSVのとき、2つ以上の連続した区切り文字の扱いを指定します。
本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	1つの区切り文字を1つの項目間の区切りとして扱います。
1	2つ以上の連続した区切り文字を1つの項目間の区切りとして扱います。

SubstituteZeroForEmpty

数値演算式の算術演算において、空の扱いを指定します。
本パラメタを省略した場合、NOが指定されたものとみなします。

設定値	意味
YES	数値演算式の算術演算において、空を0とみなして演算します。また、数値演算式の結果が空となった場合、0を出力します。
NO	数値演算式における算術演算において、演算対象に空が含まれる場合、演算結果はすべて空を返します。また、数値演算式の結果が空となった場合、何も出力しません。

注意

キー仕分け機能を使用する(AsisExecuteKeySortを実行する)場合、本環境パラメタは無効です。

QuotationMarkMode

CSV形式で出力される結果データに対して、結果データ中の文字列の項目に対して、二重引用符(”)の設定を指定できます。

本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	二重引用符(")が設定されます。
1	二重引用符(")が設定されません。

注意

キー仕分け機能を使用する(AsisExecuteKeySortを実行する)場合、本環境パラメタは無効です。
出力形式の自由化機能を利用する(リターン式に出力形式を指定する)場合、本パラメタは無効です。

SkipHeader

入力ファイルタイプがCSVで、スキーマ情報ファイルが指定されたとき、入力ファイル(連結機能の場合、入力ジャーナルファイル)の先頭行を読み飛ばすかどうかを指定します。

本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	入力ファイルの見出し行を読み飛ばしません。
1	入力ファイルの見出し行を読み飛ばします。

MstSkipHeader

入力ファイルタイプがCSVで、スキーマ情報ファイルが指定されたとき、入力マスタファイルの先頭行を読み飛ばすかどうかを指定します。

本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	入力マスタファイルの見出し行を読み飛ばしません。
1	入力マスタファイルの見出し行を読み飛ばします。

OutputGroupItem

グループ式に指定された項目を出力するかどうかを指定します。
本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	集計結果の先頭にグループ式に指定された項目を出力します。
1	集計結果の先頭にグループ式に指定された項目を出力しません。

JoinAlert

入力マスタファイルのレコードと結合されなかった入力ジャーナルファイルのレコードが存在した場合の復帰の扱いを指定します。
本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	正常終了します。
1	警告終了します。結合されなかったレコードが存在しても処理を継続し、処理完了時に警告終了します。
2	異常終了します。結合されなかったレコードが存在すると、その時点で処理を中断し異常終了します。連結条件式の結合型にINNER JOIN方式を指定した場合だけ有効です。

OutLineFeedCode

出力データにおける、レコード終端の改行コードの取り扱いを指定します。
本パラメタを省略した場合、Windowsでは“CRLF”、Linux/Solaris では“LF”が指定されたものとみなします。
ただし、入力データの内容(XMLの要素やCSVの項目内容など)にある改行コードは対象外です。入力データに存在する改行文字と同じ改行文字が出力されます。

設定値	意味
LF	Lf（0x0A）を改行コードとして認識します。
CRLF	Cr（0x0D）Lf（0x0A）を改行コードとして認識します。
NULL	NULLを指定した場合、Windowsでは“CRLF”、Linux/Solaris では“LF”が指定されたものとみなします。

ExceptRecordFolder

連結結果ファイルに出力されなかった、未連結のジャーナルレコードが出力されるディレクトリを指定します。指定したディレクトリ配下に入力ジャーナルファイルごとに、ファイルが作成され、未連結のジャーナルレコードが格納されます。本パラメタを省略した場合には、未連結のジャーナルレコードは、出力されません。

結合型にINNER JOIN方式を指定した場合、本パラメタに指定したディレクトリ配下に、未連結のジャーナルレコードが出力されます。

参照

未連結のジャーナルレコードを出力するファイル名およびその他詳細については、“1.3.1 replace用動作環境ファイル”の“ExceptRecordFolder”を参照してください。

復帰値

復帰値	説明
ASIS_SUCCESS	関数が正常に終了したことを示します。
ASIS_ERROR	関数の実行時に問題が検出されたことを示します。

関数の利用規則

Data Effectorの環境パラメタ名に、対応していない値が指定された場合、本関数はエラーで復帰します。
指定できるData Effectorの環境パラメタ名は、Data Effectorの機能ごとに異なります。

環境パラメタ名は、Data Effectorの関数用のヘッダファイル(libAsis.h)において、以下の名前の定数が定義されます。

環境パラメタ名（文字列）	ヘッダファイルにおける定義
FieldSeparator	ASIS_ENV_FieldSeparator
FieldSeparatorMode	ASIS_ENV_FieldSeparatorMode
SubstituteZeroForEmpty	ASIS_ENV_SubstituteZeroForEmpty
QuotationMarkMode	ASIS_ENV_QuotationMarkMode
SkipHeader	ASIS_ENV_SkipHeader
MstSkipHeader	ASIS_ENV_MstSkipHeader
OutputGroupItem	ASIS_ENV_OutputGroupItem
JoinAlert	ASIS_ENV_JoinAlert
OutLineFeedCode	ASIS_ENV_OutLineFeedCode
ExceptRecordFolder	ASIS_ENV_ExceptRecordFolder

注意

抽出機能の場合、AsisInitSelect関数の前に本関数で環境パラメタを設定する必要があります。
連結機能の場合、AsisInitReplace関数の前に本関数で環境パラメタを設定する必要があります。