AFNameSubstitution.ResolveName Method (AFObject, String, IFormatProvider)

public static bool ResolveName(
	AFObject item,
	string name = null,
	IFormatProvider provider = null
)

Public Shared Function ResolveName ( 
	item As AFObject,
	Optional name As String = Nothing,
	Optional provider As IFormatProvider = Nothing
) As Boolean

Dim item As AFObject
Dim name As String
Dim provider As IFormatProvider
Dim returnValue As Boolean

returnValue = AFNameSubstitution.ResolveName(item, 
	name, provider)

public:
static bool ResolveName(
	AFObject^ item, 
	String^ name = nullptr, 
	IFormatProvider^ provider = nullptr
)

static member ResolveName : 
        item : AFObject * 
        ?name : string * 
        ?provider : IFormatProvider 
(* Defaults:
        let _name = defaultArg name null
        let _provider = defaultArg provider null
*)
-> bool 

Parameters

item

Type: OSIsoft.AFAFObject
The object to be updated with the resolved name.

name (Optional)

Type: SystemString
The new name string for the item that may contain substitution fields that need to be resolved. If the name ends with an asterisk (*), then a unique name will be generated based on the supplied name after any substitution fields have been resolved. If the name is not specified or , then the NamingPattern will be used to generate the new name. See the ValidateName(String, String) method for a description of what is valid when setting the name of the object.

provider (Optional)

Type: SystemIFormatProvider
An object that supplies culture-specific formatting information used when replacing the substitution fields in the specified name. If , then InvariantCulture will be used when replacing the substitution fields. This would affect the formatting of the time related substitution fields.

Return Value

AFSDK

Reference