Class P4.Message

Description

P4.Message objects contain error or other diagnostic messages from the Helix Core Server; they are returned in P4.messages.

Script writers can test the severity of the messages in order to determine if the server message consisted of command output (E_INFO), warnings, (E_WARN), or errors (E_FAILED /E_FATAL).

Class Methods

None.

Instance Attributes

message.severity -> int

Severity of the message, which is one of the following values:

Value Meaning

E_EMPTY

No error.

E_INFO

Informational message only.

E_WARN

Warning message only.

E_FAILED

Command failed.

E_FATAL

Severe error; cannot continue.

message.generic -> int

Returns the generic class of the error, which is one of the following:

Name Value Meaning

EV_NONE

0

Miscellaneous.

EV_USAGE

0x01

Request is not consistent with dox.

EV_UNKNOWN

0x02

Using unknown entity.

EV_CONTEXT

0x03

Using entity in the wrong context.

EV_ILLEGAL

0x04

You do not have permission to perform this action.

EV_NOTYET

0x05

An issue needs to be fixed before you can perform this action.

EV_PROTECT

0x06

Protections prevented operation.

EV_EMPTY

0x11

Action returned empty results.

EV_FAULT

0x21

Inexplicable program fault.

EV_CLIENT

0x22

Client side program errors.

EV_ADMIN

0x23

Server administrative action required.

EV_CONFIG

0x24

Client configuration is inadequate.

EV_UPGRADE

0x25

Client or server too old to interact.

EV_COMM

0x26

Communications error.

EV_TOOBIG

0x27

Too big to handle.

message.msgid -> int

Returns the unique ID of the message.