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

PI Powershell

TABLE OF CONTENTS

ImportAFXml.File Property

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedDec 15, 2025
  • 6 minute read
ImportAFXml.File Property

File from which to import AF Objects

Namespace:  OSIsoft.PowerShell
Assembly:  OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFObject", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFServer", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFAttributes", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFAttributeTemplates", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFCategories", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFDatabases", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFElements", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFElementTemplates", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFEventFrames", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFPorts", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFSecurityIdentities", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFSecurityMappings", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFUnitsOfMeasure", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = "FileToAFUnitOfMeasureClasses", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")]
[ValidateNotNullOrEmptyAttribute]
public string File { get; set; }
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFObject", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFServer", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFAttributes", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFAttributeTemplates", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFCategories", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFDatabases", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFElements", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFElementTemplates", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFEventFrames", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFPorts", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFSecurityIdentities", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFSecurityMappings", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFUnitsOfMeasure", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ParameterAttribute(Position := 0, ParameterSetName := "FileToAFUnitOfMeasureClasses", 
	Mandatory := true, ValueFromPipeline := false, HelpMessage := "File to import from")>
<ValidateNotNullOrEmptyAttribute>
Public Property File As String
	Get
	Set

Dim instance As ImportAFXml
Dim value As String

value = instance.File

instance.File = value
public:
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFObject", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFServer", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFAttributes", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFAttributeTemplates", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFCategories", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFDatabases", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFElements", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFElementTemplates", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFEventFrames", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFPorts", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFSecurityIdentities", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFSecurityMappings", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFUnitsOfMeasure", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ParameterAttribute(Position = 0, ParameterSetName = L"FileToAFUnitOfMeasureClasses", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = L"File to import from")]
[ValidateNotNullOrEmptyAttribute]
property String^ File {
	String^ get ();
	void set (String^ value);
}
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFObject", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFServer", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFAttributes", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFAttributeTemplates", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFCategories", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFDatabases", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFElements", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFElementTemplates", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFEventFrames", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFPorts", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFSecurityIdentities", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFSecurityMappings", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFUnitsOfMeasure", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ParameterAttribute(Position = 0, ParameterSetName = "FileToAFUnitOfMeasureClasses", 
	Mandatory = true, ValueFromPipeline = false, HelpMessage = "File to import from")>]
[<ValidateNotNullOrEmptyAttribute>]
member File : string with get, set

Property Value

Type: String

See Also

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