DictField.flags Method

Definition

Namespace:

Dynamics.AX.Application

Assembly:

Microsoft.Dynamics.AX.Xpp.Support.dll

Overloads

flags(String, Common)
flags()	Returns an integer that defines the properties of the field. The flag values, such as DBF_MANDATORY, are defined in the DictField macro.
flags(String)

flags(String, Common)

public:
 virtual int flags(System::String ^ _ext, Microsoft::Dynamics::Ax::Xpp::Common ^ _record);

public virtual int flags (string _ext, Microsoft.Dynamics.Ax.Xpp.Common _record);

abstract member flags : string * Microsoft.Dynamics.Ax.Xpp.Common -> int
override this.flags : string * Microsoft.Dynamics.Ax.Xpp.Common -> int

Public Overridable Function flags (_ext As String, _record As Common) As Integer

Parameters

_ext

String

_record

Common

Returns

Int32

flags()

Returns an integer that defines the properties of the field. The flag values, such as DBF_MANDATORY, are defined in the DictField macro.

public:
 virtual int flags();

public virtual int flags ();

abstract member flags : unit -> int
override this.flags : unit -> int

Public Overridable Function flags () As Integer

Returns

Int32

An integer value, where each bit corresponds to a field flag.

Remarks

Use the Global::bitTest Method method or the & operator to check individual flag values.

The following example shows the retrieval of the flags of a field to determine whether the field is mandatory.

#macrolib.dictfield 
DictField df; 
int       nFlags; 
df = new DictField(tablenum(CustTable), fieldnum(CustTable, AccountNum)); 
if (df) 
{ 
    nFlags = df.flags(); 
    if (bitTest(nFlags,#DBF_MANDATORY)) 
    { 
        print ("The field is mandatory."); 
    } 
    else 
    { 
        print ("The field is not mandatory."); 
    } 
}

flags(String)

public:
 virtual int flags(System::String ^ text1);

public virtual int flags (string text1);

abstract member flags : string -> int
override this.flags : string -> int

Public Overridable Function flags (text1 As String) As Integer

Parameters

text1

String

Returns

Int32