Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAttributeTrait.GetRequiredEnumerationSet Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAttributeTrait.GetRequiredEnumerationSet Method
Gets the required AFEnumerationSet that is specified for the AFAttribute.

Namespace:  OSIsoft.AF.Asset
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFEnumerationSet GetRequiredEnumerationSet(
	AFDatabase database = null
)
Public Function GetRequiredEnumerationSet ( 
	Optional database As AFDatabase = Nothing
) As AFEnumerationSet

Dim instance As AFAttributeTrait
Dim database As AFDatabase
Dim returnValue As AFEnumerationSet

returnValue = instance.GetRequiredEnumerationSet(database)
public:
AFEnumerationSet^ GetRequiredEnumerationSet(
	AFDatabase^ database = nullptr
)
member GetRequiredEnumerationSet : 
        ?database : AFDatabase 
(* Defaults:
        let _database = defaultArg database null
*)
-> AFEnumerationSet 

Parameters

database (Optional)
Type: OSIsoft.AFAFDatabase
The AFDatabase that is used to find the AFEnumerationSet to be returned. If , then the DefaultDatabase of the DefaultPISystem will be used.

Return Value

Type: AFEnumerationSet
Returns the required AFEnumerationSet for AFAttribute. Returns if no required AFEnumerationSet is defined.

Remarks

If a required AFEnumerationSet is defined, then the TypeQualifier for the AFAttribute will be set to this value and the attribute's value must be an AFEnumerationValue from the enumeration set as defined by this trait.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in