ActiveStatus Property

Limits the search to active or inactive records only.

Syntax

int GetActiveStatus();

int SetActiveStatus(int iActiveStatus);

Possible Values

  AS_UNSPECIFIED(0), 
  AS_ACTIVE_ONLY(1), 
  AS_INACTIVE_ONLY(2), 
  AS_ALL(3)

Default Value

0

Remarks

Limits the search to active or inactive records only. May be used to limit the search to active or inactive records only.

The following values are permitted:

Only applicable to searches for entity objects.

Data Type

Integer