ProcessPIUser Property (IMessageSendNames Interface)

                    

 

ProcessPIUser  is a read-only property of the IMessageSendNames interface that returns the message parameter name expected by the MessageLog2.SendLogMessage method for specifying  the authenticated PI user associated with a message being logged.

 

The MessageLog2.SendLogMessage method will automatically add the ProcessPIUser to any log message sent to a PI server's Message log (remote messages).  When sending messages to the local log the PI-SDK can not determine the proper PI user so this property is not added automatically though can be explicitly sent by an application using this parameter.  If an application is doing work on behalf of a PI User not associated with the server connection being used to log a message, the OriginatingPIUser message property should instead be sent.

 

 

Syntax

object.ProcessPIUser

The object placeholder is an object expression that evaluates to a IMessageSendNames  interface.

 

Remarks
The IMessageSendNames interface can be obtained directly from the MessageLog2.MessageSendNames property or by using QueryInterface (assignment, in VB, casting in .Net) on a MessageLog or MessageLog2 object.

When adding to the NamedValues collection, the IMessageSendNames interface acts with Intellisense to show the available parameter options and ensures only names that are supported are used.

Enabling Operational Intelligence