PI Powershell

SetFileOptions Class

Save PDF

TABLE OF CONTENTS

SetFileOptions Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Sets the file options used to validate an AFFile stored in the PISystem.

This method will change the FileAllowedExtensions and FileMaxLength settings that are used to validate an AFFile stored in the PISystem. To add or remove file extensions from the current list, first the current PISystem.FileAllowedExtensions, list and make changes to that list, and the pass the updated list to this method.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellSetFileOptions

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

Syntax

[CmdletAttribute("Set", "AFFileOptions", SupportsShouldProcess = true)]
public class SetFileOptions : OSICmdletBase

<CmdletAttribute("Set", "AFFileOptions", SupportsShouldProcess := true)>
Public Class SetFileOptions
	Inherits OSICmdletBase

Dim instance As SetFileOptions

[CmdletAttribute(L"Set", L"AFFileOptions", SupportsShouldProcess = true)]
public ref class SetFileOptions : public OSICmdletBase

[<CmdletAttribute("Set", "AFFileOptions", SupportsShouldProcess = true)>]
type SetFileOptions =  
    class
        inherit OSICmdletBase
    end

The SetFileOptions type exposes the following members.

Constructors

	Name	Description
	SetFileOptions

Properties

	Name	Description
	AFServer	Instance of the AFServer
	AllowedFileExtensions	File Extensions which are to be permitted
	MaxFileLength	Maximum File Length to be permitted

Examples

$afServer | Set-AFFileOptions -AllowedFileExtensions "xyz" "abc" -MaxFileLength 10

Where:

$afServer = Get-AFServer -Name "AFServerMachineName"

Sets the file options used to validate an AFFile stored in the PISystem.

PI Powershell