GetPIMessage Properties
- Last UpdatedDec 15, 2025
- 3 minute read
The GetPIMessage type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Category | Category mask to search for | |
| Connection | Connection to a PI Data Archive from which to get the message(s) | |
| Count | Maximum number of messages to retrieve | |
| EndTime | End time for which to retrieve messages | |
| Id | Message ID to search for. Multiple Message IDs can be searched by specifying a comma separated list | |
| Message | Message string mask to search for | |
| OriginatingHost | Originating hostname of the message to search for | |
| OriginatingOSUser | Originating OS User of the message to search for | |
| OriginatingPIUser | Originating PI User of the message to search for | |
| Priority | Message priority to search for | |
| ProcessHost | Hostname of the machine running the process that issued the message to search for | |
| ProcessId | ProcessID of ProgramName to search for | |
| ProcessOSUser | OS User under which the process issuing the message runs to search for | |
| ProcessPIUser | PI User Identity of the process issues the message to search for | |
| Program | Program mask to search for | |
| SeverityType | Message severity level to retrieve. Severity levels are: "Debug" -> "Informational" -> "Warning" -> "Error" -> "Critical" | |
| Source1 | Source1 mask to search for | |
| Source2 | Source2 mask to search for | |
| Source3 | Source3 mask to search for | |
| SourceAny | Source mask for any source field to search for (includes Source1, Source2, and Source3) | |
| StartTime | Start time for which to retrieve messages |
See Also
In This Topic
Related Links
- Category Property
- Connection Property
- Count Property
- EndTime Property
- Id Property
- Message Property
- OriginatingHost Property
- OriginatingOSUser Property
- OriginatingPIUser Property
- Priority Property
- ProcessHost Property
- ProcessId Property
- ProcessOSUser Property
- ProcessPIUser Property
- Program Property
- SeverityType Property
- Source1 Property
- Source2 Property
- Source3 Property
- SourceAny Property
- StartTime Property