Extended API Functions

With the introduction of the PI historian on Windows NT and UNIX platforms, new functionality has been added. Archives on these platforms support high precision time stamps, and string values. A set of functions has been added to the PI-API to provide access to these new features. You must be running at least version 3.1 of the PI Data Archive to use these features.

Function Description
piar_getarcvaluesfilterx Retrieves evenly spaced, timed or compressed archive data which passes a filter expression.
piar_getarcvaluesx Retrieves evenly spaced, timed or compressed archive data.
piar_getarcvaluex Retrieves a single archive value.
piar_putarcvaluesx Adds a value to the Data Archive
piar_putarcvaluex Adds a values to the Data Archive
pipt_descriptorx Returns descriptor point attribute of passed point.
pipt_exdescx Returns extended descriptor point attribute of passed point.
pipt_instrumenttagx Returns instrumenttag point attribute of passed point.
pipt_pointtypex Returns a detailed data type code for the passed PI point number.
pipt_tagnamex Returns tagname point attribute of passed point.
pisn_evmexceptionsx Retrieves exception values from the PI Server for points which the client has registered.
pisn_evmexceptx Returns exception values for points which have previously been registered with the PI System exception server (Update Manager subsystem).
pisn_flushputsnapqx Sends the queued values to the server from the extended values queue.
pisn_getsnapshotsx Retrieves events from the Snapshot for several points.
pisn_getsnapshotx Retrieves a single event from the Snapshot.
pisn_putsnapshotqx Puts a single value into the PI System Snapshot using the extended data queue if flagged.
pisn_putsnapshotsx Puts an array of values into the PI System Snapshot.
pisn_putsnapshotx Puts a single value into the PI System Snapshot.
pisn_sendexceptionqx Sends an exception value to PI.
pisn_sendexceptionsx Sends an array of exception values to PI.
pisn_sendexceptqx Adds a new event to the PI System Snapshot if it passes the exception test.
pitm_getpitime Obtains a PI 2.0 System time from a PITIMESTAMP structure. Fraction of second returned optionally.
pitm_getutctime Accepts a PITIMESTAMP structure and UTC time for the time stamp
pitm_isdst Checks whether a timestamp is DST or ST.
pitm_setcurtime Populates a PITIMESTAMP structure with the current time. Use a passed flag to indicate whether or not fractions of one second should be included.
pitm_setdst Set a PITIMESTAMP to the passed DST/ST setting.
pitm_setpitime Populates a PITIMESTAMP structure with the passed PI 2.0 System time. Fraction of second passed through a separate argument.
pitm_settime Populates a PITIMESTAMP structure with the passed time components (i.e. year, month, day, hour, minute and second.
piut_fastserverversion Returns server version information without a network call each time.
piut-getserverversion Returns server version information.
piut_setappidentity Sets client application identity which is passed when connecting to PI3 server.
piut_setpassword Changes the PI3 password.
piut_strerror Translates an error number to an error message.

Enabling Operational Intelligence