AFPathFilter Structure
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
A filter to restrict the objects found from a path.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156
Syntax
[SerializableAttribute] public struct AFPathFilter : IEquatable<AFPathFilter>
<SerializableAttribute> Public Structure AFPathFilter Implements IEquatable(Of AFPathFilter) Dim instance As AFPathFilter
[SerializableAttribute] public value class AFPathFilter : IEquatable<AFPathFilter>
[<SealedAttribute>] [<SerializableAttribute>] type AFPathFilter = struct interface IEquatable<AFPathFilter> end
The AFPathFilter type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Expression |
The filter expression.
|
| Index |
The zero-based index of the desired object within the returned collection.
|
| Type |
The filter type.
|
Methods
| Name | Description | |
|---|---|---|
 | Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ValueType.Equals(Object).) |
| Equals(AFPathFilter) |
Indicates whether the current object is equal to another object of the same type.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides ValueType.GetHashCode().) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a String that represents the current object.
(Overrides ValueType.ToString().) |
Operators
| Name | Description | |
|---|---|---|
  | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
Fields
| Name | Description | |
|---|---|---|
 | Empty |
Represents an empty path filter.
|
Remarks
The AFPathToken contains a list of filters that are
used to restrict the objects found when searching for an
object.