PI Powershell

GetPIStatus Class

Save PDF

TABLE OF CONTENTS

GetPIStatus Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

GetPIStatus Class

Get information about a PI Status code

The Get-PIStatus cmdlet gets information regarding a PI Status code.

Note that all PI-specific error codes are negative (preceded by a "-"). Windows error codes may also appear in error codes and messages, however, these codes are positive. The Get-PIStatus cmdlet can be used to lookup both PI-specific or Windows Error codes.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIStatus

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Get", "PIStatus", SupportsShouldProcess = true)]
public class GetPIStatus : OSICmdletBase

<CmdletAttribute("Get", "PIStatus", SupportsShouldProcess := true)>
Public Class GetPIStatus
	Inherits OSICmdletBase

Dim instance As GetPIStatus

[CmdletAttribute(L"Get", L"PIStatus", SupportsShouldProcess = true)]
public ref class GetPIStatus : public OSICmdletBase

[<CmdletAttribute("Get", "PIStatus", SupportsShouldProcess = true)>]
type GetPIStatus =  
    class
        inherit OSICmdletBase
    end

The GetPIStatus type exposes the following members.

Constructors

	Name	Description
	GetPIStatus

Properties

	Name	Description
	Status	Status code for which to lookup information. PI-specific codes are negative (preceded by a "-"), while Windows codes are positive.

Examples

Get-PIStatus -Status -7

Gets the information related to error code "-7". Note that this is a PI-specific error code because it is negative. The code translates to:

[-7] Tag Already Exists

Examples

Get-PIStatus -Status 5

Gets the information related to error code "5". Note that this is not a PI-specific error code because it is positive. The code translates to:

[5] Access is denied.

PI Powershell