Macros in D365 F&O

Rumman Ansari   Software Engineer   2024-08-05 03:17:31   215  Share
Subject Syllabus DetailsSubject Details
☰ TContent
☰Fullscreen

Table of Content:

Macros are predefined values used throughout the solution, and they are just mechanisms by which a value (a bit of string) can be defaulted within your code, so that you won't have to hardcode values.

Macros

Macros are constants or pieces of code that are being taken care of by the compiler before the rest of the code in order to replace the code where the macro is used with the content of the macro. There are three different types of macros: standalone macros, local macros, and macro libraries.

Macros are typically constant values that are only changed by developers. They are used so that developers don't have to hardcode these kind of values in the X++ code.

The macro libraries can be found in AOT under Macros. Each of them can contain multiple macros that can be used throughout the rest of AX.

To use the macros from a macro library in AX, simply include them in the scope that you would like to use them. The following example shows how to use two different macros from the same macro library in a job.

First, we create a macro library that consists of two macros:


#define.Text('This is a test of macros') 
#define.Number(200)

Then, we use these macros from within a job:


static void Datatypes_macro_library (Args_args)

{

// Referencing macro library has to be done in the class declaration

// or in the declaration like in this example #MacroTest

info (strfmt("Text: %1. Number: %2", #Text, #Number));

}

This job will print the following output in the infolog:

Macro Output Example
Figure: Macro Output Example

Local Macro

A local macro is defined in the class declaration of a class or in the variable declaration of a method, as shown in the following example:


static void Local_Macro (Args _args)

{

// Define the local macro

#localmacro.WelcomeMessage

{
 info("We have the best offers for rental cars");

 info("Welcome to Carz Inc.");

}

#endmacro;

// Use the local macro #WelcomeMessage

}

Standalone macros are the same as the macros used in macro libraries, except that they are defined in the declaration of one of the variables of the method or in the class declaration of a class.