PISystems.AFDirectoryOptions Enumeration
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines the directory options used when looking up a PISystem
in the PISystems collection or a PIServer in
the PIServers collection.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[FlagsAttribute] public enum AFDirectoryOptions
<FlagsAttribute> Public Enumeration AFDirectoryOptions Dim instance As PISystems.AFDirectoryOptions
[FlagsAttribute] public enum class AFDirectoryOptions
[<FlagsAttribute>] type AFDirectoryOptions
Members
| Member name | Value | Description | |
|---|---|---|---|
| None | 0 | No option has been set. When looking for an item in the collection by name and the item cannot be found in the existing collection, then no additional attempt to find the item will be made. | |
| AutoAdd | 1 | When looking for an item in the collection by name and the item cannot be found in the existing collection, a new object is automatically added if the specified name is valid. If CheckIP is set, then the specified name is checked for a resolvable network address before adding. | |
| CheckIP | 2 | If a new object is to be added as a result of the AutoAdd option, then the specified name is checked for a resolvable network address before it is added. The minimum and maximum timeouts before an invalid host address is checked again is determined by the MinCheckIPTimeout and MaxCheckIPTimeout settings. | |
| Default | 3 | Default option has AutoAdd and CheckIP enabled. |
Remarks
This enumeration defines the directory options for the
PISystems.DirectoryOptions and
PIServers.DirectoryOptions
properties.
The PISystems.DirectoryOptions
property controls the behavior of the collection methods used to look up a
PISystem in the PISystems collection.
The PIServers.DirectoryOptions
property controls the behavior of the collection methods used to look up a
PIServer in the PIServers collection.