X++ コンパイル時関数

この記事では、コンパイル時関数の一覧を示し、その構文、パラメーター、および戻り値について説明します。

概要

コンパイル時関数は、X++ コードのコンパイル中の早い段階で実行されます。 可能な限り使用して、アプリケーション エクスプローラーに格納されているメタデータに対する変更に対するコードの回復性を高める必要があります。 コンパイル時関数は、コンパイラによって入力値が検証されます。 入力値がアプリケーション エクスプローラーの既存のオブジェクトと一致することが見つからない場合、コンパイラはエラーを発行します。 コンパイラは実行時に変数に含まれる値を判断できないため、これらの関数への入力はリテラル値である必要があります。 コンパイル時関数は、メタデータ アサーション関数です。 アプリケーション エクスプローラーでエンティティを表す引数を受け取り、コンパイル時に引数を検証します。 実行時に影響を与えません。 フォーム、レポート、クエリ、メニュー のメタデータの検証をサポートするには、コントロールの AutoDeclaration プロパティを使用します。 文字列リテラルよりもコンパイル エラーを取得し、実行時にエラーを取得することをお勧めします。

いくつかの一般的なコンパイル時機能は、次のとおりです。

• tableStr - 指定された名前がテーブルを指定していることを確認します。
• classStr – その名前のクラスが存在することを確認します。

組み込み関数は、X++ の特殊な構文形式です。 引数は、引用符で囲まれた文字列として、または単に引数を一覧表示することによって指定できます。 次のリファレンス:

str s = classStr(MyClass); // No quotes

そして

str s = classStr("MyClass"); // class name in quotes.

は意味的に同じです。 以下の説明では、単に引数を示します。型は指定しません。これはコンテキストから明らかです。

Functions

attributeStr

指定した属性クラスがアプリケーション エクスプローラーに存在することを検証します。そうでなければ、コンパイラ エラーが発生します。

構文

str classStr(name)

パラメーター

戻り値

属性の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

str s = attributeStr(AifDocumentOperationAttribute);

classStr

文字列としてクラスの名前を取得します。

構文

str classStr(name)

パラメーター

戻り値

クラスの名前。

備考

リテラル テキストの代わりにこの関数を使用して、クラス名を含む文字列を取得します。 コンパイル時関数の詳細については、「 概要」を参照してください。

例

s = classStr(Global); // returns "Global", since there is a class by that name.

configurationKeyStr

文字列としてコンフィギュレーション キーの名前を取得します。

構文

str configurationKeyStr(name)

パラメーター

戻り値

コンフィギュレーション キーの名前。

備考

リテラル テキストの代わりにこの関数を使用して、構成キー名を含む文字列を取得します。 キーが存在しない場合、関数はコンパイル時に構文エラーを生成します。 コンパイル時関数の詳細については、「 概要」を参照してください。

例

s = configurationKeyStr(AIF); // Returns "AIF" if there is a configuration key of that name

dataEntityDataSourceStr

データ エンティティのデータ ソースの名前を取得します。

構文

str dataEntityDataSourceStr(dataEntity, dataSource)

パラメーター

戻り値

データ ソースの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

delegateStr

委任の名前を返します。

構文

str delegateStr(class, instanceDelegate)

パラメーター

戻り値

委任の名前です。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

dimensionHierarchyLevelStr

分析コード階層レベルの名前を返します。

構文

str dimensionHierarchyLevelStr(dimensionHierarchyLevel)

パラメーター

戻り値

分析コード階層レベルの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

dimensionHierarchyStr

分析コード階層の名前を返します。

構文

str dimensionHierarchyStr(dimensionHierarchy)

パラメーター

戻り値

分析コード階層の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

dimensionReferenceStr

分析コード参照の名前を返します。

構文

str dimensionReferenceStr(dimensionReference)

パラメーター

戻り値

分析コード参照の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

dutyStr

指定したセキュリティ職務権限の名前を表す文字列を取得します。

構文

str dutyStr(securityDuty)

パラメーター

戻り値

文字列のセキュリティ職務の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

enumCnt

指定された列挙型の要素数を取得します。

構文

int enumCnt(enumtype)

パラメーター

戻り値

指定された列挙型の要素数。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

var cnt = enumCnt(NoYes); // Returns 2, as the two elements in the NoYes enum are Yes and No.

enumLiteralStr

指定した文字列が指定した列挙型の要素であるかどうかを示します。

構文

enumLiteralStr(enum, literal)

パラメーター

戻り値

指定した文字列が見つかった場合のリテラル パラメーターの値。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

var literal = enumLiteralStr(ABCEnum, valueInABCEnum);

enumStr

文字列として列挙型の名前を取得します。

構文

str enumStr(enumName)

パラメーター

戻り値

列挙型の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

str s = enumStr(ABC); // Returns "ABC" is an enum exists by that name. Otherwise an error is diagnosed.

extendedTypeStr

文字列として拡張データ型の名前を取得します。

構文

str extendedTypeStr(edtName)

パラメーター

戻り値

拡張データ型の名前。

備考

リテラル テキストの代わりにこの関数を使用すると、拡張データ型名を含む文字列を返します。 コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "AccountName" is an extended datatype by that name exists. If no
// such type exists, a error is diagnosed.
var edt = extendedTypeStr(AccountName); 

fieldPName

指定されたフィールドのラベルを取得します。

構文

str fieldPName(tableid, fieldid)

パラメーター

戻り値

フィールドのラベル。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

次の例では、CashDisc フィールドのラベルを出力します。

static void fieldPNameExample(Args _arg)
{
    str myText;

    myText = fieldPName(CustTable, CashDisc);
    info(strfmt("%1 is the label of the CashDisc field.", myText));
}
/****Infolog Display
Message (02:00:57 pm)
Cash discount is the label of the CashDisc field.
****/

fieldStr

指定したフィールドのフィールド名を取得します。

構文

str fieldStr(tableid, fieldid)

パラメーター

戻り値

指定したフィールドのフィールド名。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

次の例では、CashDisc フィールドの名前を myText 変数に割り当てます。

static void fieldStrExample(Args _arg)
{
    str myText = fieldStr(CustTable, CashDisc);
    info(strfmt("%1 is the specified field.", myText));
}
/****Infolog Display
Message (09:11:52 am)
CashDisc is the specified field.
****/

formControlStr

X++ コンパイラは、コントロールがフォームに存在するかどうかをチェックし、関数呼び出しを有効なコントロール名の文字列で置き換えます。

構文

str formControlStr(formName, controlName)

パラメーター

戻り値

アプリケーション エクスプローラーで表示されるコントロールの名前を含む文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

formDataFieldStr

フォームのデータ フィールドの名前を返します。

構文

str formDataFieldStr(formName, dataSource, dataField)

パラメーター

戻り値

フォームのデータ フィールドの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "RatePerDay" if the FMVehicle form contains a datasource
// called FMModelRate with a datafield called RatePerDay.
str a = formDataFieldStr(FMVehicle, FMModelRate, RatePerDay);

formDataSourceStr

フォームのデータ ソースの名前を返します。

構文

str formDataSourceStr(formName, dataSource)

パラメーター

戻り値

フォームのデータ ソースの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "FMModelRate" is there is a form called FmVehicle with a
// datasource called FMModelRate.
str b = formDataSourceStr(FMVehicle, FMModelRate);

formMethodStr

フォームのメソッドの名前を返します。

構文

str formMethodStr(formName, methodName)

パラメーター

戻り値

フォームのメソッドの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "showDialog" if there is a form called Batch with a 
// method called showDialog.
str c = formMethodStr(Batch,showDialog);

formStr

フォームの名前を取得します。

構文

str formStr(form)

パラメーター

戻り値

フォームの名前を表す文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

次の例では、InventDim フォームの名前を出力します。

// Returns "InventDim" if there is a form defined by that name.
var s = formStr(InventDim); 

identifierStr

指定された識別子を文字列に変換します。

構文

str identifierStr(ident)

パラメーター

戻り値

指定した ID を表す文字列。

備考

使用可能な場合は、より具体的なコンパイル時関数を使用します。 これは、コンパイル時関数です。 引数のチェックは実行されません。 詳細については、「概要」を参照してください。

例

次のコード例では、myvar 変数名を thevar 変数に割り当てています。

static void indentifierStrExample(Args _args)
{
    str thevar = "[" + identifierStr(myvar) + "]";
    info(strfmt(thevar));
}
/****Infolog Display
Message (09:19:49 am)
[myvar]
****/

indexStr

指定されたインデックスを文字列に変換します。

構文

str indexStr(str tableid, str indexid)

パラメーター

戻り値

指定インデックスを表す文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

次の例では、CashDisc インデックス値を myText 変数に割り当てます。

// Returns "SSNIndex" if there is a table called MyTable with an index called SSNIndex.
var idx = indexStr(MyTable, SSNIndex);

literalStr

指定した文字列がリテラル文字列であることを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str literalStr(literal)

パラメーター

戻り値

有効な場合は、リテラル文字列。

備考

この関数は、次の例に示すように、ラベルの検索が行われずにラベル文字列を返すために使用される場合があります。 コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "This is a literal str"
var s = literalStr("This is a literal str");

// Returns the string "@SYS12345", not the label that this
// label specifier may represent.
var labelStr = literalStr("@SYS12345");

maxDate

日付型の変数に使用できる最大値を取得します。

構文

date maxDate()

戻り値

日付 の変数に使用できる最大値は、2154-12-31です。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

static void maxDateExample(Args _arg)
{
    date maximumDate = maxDate();
    print maximumDate;
    pause;
}

maxInt

int 型に格納可能な最大符号付き値を取得します。

構文

int maxInt()

戻り値

整数の許容値 (2147483647)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

static void maxIntExample(Args _arg)
{
    print "The maximum value for type int is " + int2Str(maxInt());
    pause;
}

measurementStr

測定の名前を返します。

構文

str measurementStr(measurement)

パラメーター

戻り値

測定の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

measureStr

メジャーの名前を返します。

構文

str measureStr(measure)

パラメーター

戻り値

測定の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

menuItemActionStr

アクション メニュー項目の値を返します。

構文

str menuItemActionStr(menuitem)

パラメーター

戻り値

アクション メニュー項目の名前 (有効な場合)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// returns 'AssetCopy' if there is an Action menu of that name defined.
var s1 = menuItemActionStr(AssetCopy);

menuItemDisplayStr

表示メニュー項目の値を返します。

構文

str menuitemdisplaystr(menuItem)

パラメーター

戻り値

指定した表示メニュー項目の表示の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "Address" if a display menu item of that name is defined.
var s2 = menuItemDisplayStr(Address);

menuItemOutputStr

出力メニュー項目の値を返します。

構文

str menuItemOutputStr(menuitem)

パラメーター

戻り値

有効な場合は、指定された出力メニュー項目の出力。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "AssetBarCode" if an output menu item by that name exists.
var s = menuItemOutputStr(AssetBarcode);

menuStr

メニューの名前の値を返します。

構文

str menuStr(menu)

パラメーター

戻り値

有効な場合の指定されたメニュー項目の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "Administration" if a menu by that name is defined.
var s = menuStr(Administration);

methodStr

クラス インスタンス メソッドの名前を返します。

構文

str methodStr(class, method)

パラメーター

戻り値

指定したインスタンス メソッドの名前 (有効な場合)。

備考

この関数は、静的なメソッドのエラーを診断します。 静的メソッドには staticMethodStr を使用します。 コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "timeout" if there is a class called SysHelpInitTimeout that 
// has a method called timeout.
var s = methodStr(SysHelpInitTimeOut, timeout);

minInt

int 型に格納可能な最小符号付き値を取得します。

構文

int minInt()

戻り値

int 型の最小値 (-2147483648)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

static void minIntExample(Args _arg)
{
    int i = minInt();
    print "minInt() is " + int2Str(i);    
    pause;
}

privilegeStr

権限の名前を返します。

構文

str privilegeStr(privilege)

パラメーター

戻り値

権限の名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

queryDatasourceStr

クエリのデータソースの名前を返します。

構文

str queryDataSourceStr(queryName, dataSourceName)

パラメーター

戻り値

データ ソースの名前を含む文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

queryMethodStr

クエリのメソッドの名前を返します。

構文

str queryMethodStr(queryName, methodName)

パラメーター

戻り値

クエリのメソッドの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

queryStr

既存のクエリを表す文字列を取得します。

構文

str queryStr(query)

パラメーター

戻り値

クエリの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'AssetTable' if a query by that name is defined.
str myText = queryStr(AssetTable);

reportStr

指定したレポートの名前を表す文字列を取得します。

構文

str reportStr(report)

パラメーター

戻り値

レポートの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns "AssetAddition" if a report by that name is defined.
var r = reportStr(AssetAddition);

resourceStr

指定したリソースがアプリケーション エクスプローラーに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str resourceStr(resourcename)

パラメーター

戻り値

指定したリソースの名前 (有効な場合)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// R'eturns 'StyleSheet_Help_Axapta' if a resource by that name is defined.
var r = resourceStr(StyleSheet_Help_Axapta);

roleStr

指定したセキュリティ ロールの名前を表す文字列を取得します。

構文

str roleStr(securityRole)

パラメーター

戻り値

文字列のセキュリティ ロールの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

ssrsReportStr

指定した SSRS レポートの名前を表す文字列を取得します。 レポート コントローラー クラスで実行されるレポートを指定する場合は、この関数を使用します。

構文

str ssrsReportStr(report, design)

パラメーター

戻り値

レポートの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

public static void main(Args _args)
{
    // Initializing the object for a controller class, in this case, the class named AssetListingController.
    SrsReportRunController controller = new AssetListingController();

    // Getting the properties of the called object (in this case AssetListing MenuItem)
    controller.parmArgs(_args);

    // Setting the Report name for the controller.
    controller.parmReportName(ssrsReportStr(AssetListing, Report));

    // Initiate the report execution.
    controller.startOperation();
}

staticDelegateStr

静的デリゲートの名前を返します。

構文

str staticDelegateStr(class, delegate)

パラメーター

戻り値

委任の名前です。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

staticMethodStr

指定した静的メソッドが指定したクラスに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str staticMethodStr(class, int method)

パラメーター

戻り値

静的メソッドの名前 (有効な場合)。

備考

指定されたメソッドが静的でない場合、この関数は失敗します。 インスタンス メソッドの名前を返す場合は、methodStr 関数を使用します。 コンパイル時関数の詳細については、「 概要」を参照してください。

tableCollectionStr

指定したテーブル コレクションがアプリケーション エクスプローラーに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str tableCollectionStr(tablecollection)

パラメーター

戻り値

指定したテーブル コレクションの名前 (有効な場合)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

tableFieldGroupStr

文字列としてフィールド グループの名前を取得します。

構文

str tableFieldGroupStr(tableName, fieldGroupName)

パラメーター

戻り値

文字列としてのフィールド グループの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

次の例では、編集 フィールド グループの名前を文字列として取得します。

// Returns 'Editing' if there is a table called AccountingDistribution that has a
// fieldgroup called Editing.
var fg = tableFieldGroupStr(AccountingDistribution, Editing);

tableMethodStr

指定したインスタンス メソッドが指定したテーブルに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str tableMethodStr(table, method)

パラメーター

戻り値

インスタンス メソッドの名前 (有効な場合)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

tablePName

指定されたテーブルの出力可能な名前を含む文字列を取得します。

構文

str tablePName(str table)

パラメーター

戻り値

指定されたテーブルの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

次の例では、CustTable テーブルのラベルを MyText 変数に割り当てます。

static void tablePNameExample(Args _args)
{
    str MyText = tablePname(CustTable);
    info(strfmt("%1 is the label of the CustTable table.", MyText));
}
/**** Infolog Display.
Message (12:13:53 pm)
Customers is the label of the CustTable table.
****/

tableStaticMethodStr

指定した静的メソッドが指定したテーブルに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str tableStaticMethodStr(table, method)

パラメーター

戻り値

指定された静的メソッドの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

tableStr

指定したテーブルの名前を含む文字列を取得します。

構文

str tableStr(table)

パラメーター

戻り値

指定したテーブルの名前を含む文字列値。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'CustTable' if a table by that name is defined.
var t = tableStr(CustTable);

tileStr

指定したタイルの名前を表す文字列を取得します。

構文

str tileStr(tile)

パラメーター

戻り値

文字列のタイルの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

varStr

指定した変数の名前を含む文字列を取得します。

構文

str varStr(name)

パラメーター

戻り値

呼び出しのスコープ内の項目の名前を含む文字列。

備考

名前は、呼び出しが発生するメソッドで定義されている変数、または周囲のスコープ内のフィールドと一致する必要があります。 コンパイル時関数の詳細については、「 概要」を参照してください。

例

static void varStrExample(Args _arg)
{
    str myString;
    anytype myVariable;

    myString = varStr(myVariable);
    info(strfmt("%1 is the variable name.", myString));
}
/****Infolog Display.
Message (02:26:56 pm)
myVariable is the variable name.
****/

webActionItemStr

指定した Web アクション項目がアプリケーション エクスプローラーに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str webActionItemStr(webactionitem)

パラメーター

戻り値

指定した Web アクション 項目の名前 (有効な場合)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'EPFlushData' if a web action by that name is defined.
str s = webActionItemStr(EPFlushData);

webDisplayContentItemStr

指定された Web 表示コンテンツ項目がアプリケーション エクスプローラーに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str webDisplayContentItemStr(webdisplaycontentitem)

パラメーター

戻り値

指定した Web 表示コンテンツ アイテムの名前 (有効な場合)。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'EPAdmin' if a web display content item by that name is defined.
str s = webDisplayContentItemStr(EPAdmin);

workflowApprovalStr

アプリケーション オブジェクト ツリー (アプリケーション エクスプローラー) でワークフロー承認の名前を文字列として取得します。

構文

str workflowapprovalstr(approval)

パラメーター

戻り値

ワークフローの承認のアプリケーション エクスプローラーの名前を表す文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'MyWorkflowApproval' if a workflow approval by that name is defined.
str s = workflowapprovalstr(MyWorkflowApproval);

workflowCategoryStr

アプリケーション オブジェクト ツリー (アプリケーション エクスプローラー) でワークフロー カテゴリの名前を文字列として取得します。

構文

str workflowcategorystr(category)

パラメーター

戻り値

ワークフロー カテゴリのアプリケーション エクスプローラーの名前を表す文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'MyWorkflowCategory' if a workflow category by that name is defined.
str s = workflowcategorystr(MyWorkflowCategory);

workflowTaskStr

アプリケーション オブジェクト ツリー (アプリケーション エクスプローラー) でワークフロー タスクの名前を文字列として取得します。

構文

str workflowtaskstr(task)

パラメーター

戻り値

ワークフロー タスクのアプリケーション エクスプローラーの名前を表す文字列。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'MyWorkflowTask' si a workflow task by that name has been defined.
str s = workflowtaskstr(MyWorkflowTask);

workflowTypeStr

指定したワークフローの種類がアプリケーション エクスプローラーに存在することを検証します。そうでない場合は、コンパイラ エラーが発生します。

構文

str workflowTypeStr(workflow)

パラメーター

戻り値

ワークフロー タイプの名前。

備考

コンパイル時関数の詳細については、「 概要」を参照してください。

例

// Returns 'BudgetAccountEntryType' if a workflow by that name is defined.