PI Powershell

GetPIPoint.WhereClause Property

Save PDF

GetPIPoint.WhereClause Property

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

WhereClause used to filter PI Points returned. The format of the WhereClause is Attribute:[Operator][Value] For example:

Tag:=Sinusoid

Multiple comparisons can be specified, separated by spaces. The following operators are supported: Equals: = Not equals: != or <> Greater than: > Greater than or equal to >= Less than: < Less than or equal to: <= If the Operator is omitted, equals is assumed.

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

Syntax

[ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = "ByWhereClauseSpecifyAttributes", 
	HelpMessage = "Where clause for retrieving points")]
[ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = "ByWhereClauseAllAttributes", 
	HelpMessage = "Where clause for retrieving points")]
[ValidateNotNullOrEmptyAttribute]
public string WhereClause { get; set; }

<ParameterAttribute(Position := 0, Mandatory := true, ParameterSetName := "ByWhereClauseSpecifyAttributes", 
	HelpMessage := "Where clause for retrieving points")>
<ParameterAttribute(Position := 0, Mandatory := true, ParameterSetName := "ByWhereClauseAllAttributes", 
	HelpMessage := "Where clause for retrieving points")>
<ValidateNotNullOrEmptyAttribute>
Public Property WhereClause As String
	Get
	Set

Dim instance As GetPIPoint
Dim value As String

value = instance.WhereClause

instance.WhereClause = value

public:
[ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = L"ByWhereClauseSpecifyAttributes", 
	HelpMessage = L"Where clause for retrieving points")]
[ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = L"ByWhereClauseAllAttributes", 
	HelpMessage = L"Where clause for retrieving points")]
[ValidateNotNullOrEmptyAttribute]
property String^ WhereClause {
	String^ get ();
	void set (String^ value);
}

[<ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = "ByWhereClauseSpecifyAttributes", 
	HelpMessage = "Where clause for retrieving points")>]
[<ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = "ByWhereClauseAllAttributes", 
	HelpMessage = "Where clause for retrieving points")>]
[<ValidateNotNullOrEmptyAttribute>]
member WhereClause : string with get, set

Property Value

Type: String

PI Powershell