AFNameSubstitution.GetSubstitutionList Method

public static IList<KeyValuePair<string, AFNameSubstitutionType>> GetSubstitutionList(
	AFNameSubstitutionFilters filters = AFNameSubstitutionFilters.None
)

Public Shared Function GetSubstitutionList ( 
	Optional filters As AFNameSubstitutionFilters = AFNameSubstitutionFilters.None
) As IList(Of KeyValuePair(Of String, AFNameSubstitutionType))

Dim filters As AFNameSubstitutionFilters
Dim returnValue As IList(Of KeyValuePair(Of String, AFNameSubstitutionType))

returnValue = AFNameSubstitution.GetSubstitutionList(filters)

public:
static IList<KeyValuePair<String^, AFNameSubstitutionType>>^ GetSubstitutionList(
	AFNameSubstitutionFilters filters = AFNameSubstitutionFilters::None
)

static member GetSubstitutionList : 
        ?filters : AFNameSubstitutionFilters 
(* Defaults:
        let _filters = defaultArg filters AFNameSubstitutionFilters.None
*)
-> IList<KeyValuePair<string, AFNameSubstitutionType>> 

Parameters

filters (Optional)

Type: OSIsoft.AFAFNameSubstitutionFilters
These filters are used to restrict the substitution patterns returned from this method. The Create filter will only return the substitution patterns that can be used when creating a new object. Specify None to return the full list of substitution patterns. More than one filter can be specified by ORing the filter values together.

Return Value

This method can be used to get the list of supported substitution fields for a name. See AFNameSubstitutionType for description of the substitution fields. By default the full list of substitution patterns are returned. Specify one or more filters to restrict the list if patterns returned. For example, a filter of Create will return only the substitutions that are valid for creating new objects with the AFElementTemplate.NamingPattern.

AFSDK

Reference