C.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形式の場合、項目間の区切り文字の扱いを指定します。	○	○	○	○
PathNameCompatibility	入出力ファイルのパス形式を指定します。	○	○	○	○
SubstituteZeroForEmpty	数値演算式における空の扱いを指定します。	―	○	○	○
TextNodeCompatibility	入力ファイルタイプがXMLの場合、特殊なデータを含む場合の抽出処理の扱いを指定します。	○	―	―	―

○：指定可能
―：指定無効

Value

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

注意

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

FieldSeparator

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

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

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

注意

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

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

FieldSeparatorMode

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

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

PathNameCompatibility

入出力ファイルのパス名の形式を指定します。
本パラメタを省略した場合、0が指定されたものとみなします。

設定値	意味
0	見出し行とデータ行を分ける出力方法です。
1	見出し行とデータ行を分けない出力方法です。

SubstituteZeroForEmpty

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

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

TextNodeCompatibility

入力ファイルタイプがXMLの場合、以下の特殊なデータを含む場合の抽出処理の扱いを指定します。
本パラメタを省略した場合、0が指定されたものとみなします。

コメントセクション
CDATAセクション
処理命令
混在内容
設定値
意味
0
V9.1系の形式で抽出結果を出力します。
1
V9.0系の互換形式の抽出結果を出力します。

設定値	意味
0	V9.1系の形式で抽出結果を出力します。
1	V9.0系の互換形式の抽出結果を出力します。

注意

本パラメタに1を指定した場合、以下の機能は使用できません。

検索式に関数を指定する
日時データを検索する

ポイント

混在内容

要素ノードの子ノードに、テキストノードと要素ノードが混在するXML形式のことです。
詳細については、“2.4.2 1つの要素ノード配下にテキストノードと要素ノードが混在しているデータの扱い”を参照してください。

参照

互換形式の抽出結果の詳細については、“リリース情報”の“互換に関する情報”を参照してください。

復帰値

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

関数の利用規則

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

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

環境パラメタ名（文字列）	ヘッダファイルにおける定義
FieldSeparator	ASIS_ENV_FieldSeparator
FieldSeparatorMode	ASIS_ENV_FieldSeparatorMode
PathNameCompatibility	ASIS_ENV_PathNameCompatibility
SubstituteZeroForEmpty	ASIS_ENV_SubstituteZeroForEmpty
TextNodeCompatibility	ASIS_ENV_TextNodeCompatibility

注意

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