ValidateSignatureAndWriteValue Method

Performs validation of both the Performed By and Verified By user names and passwords. Based on the value of the nAction parameter, the ValidateSignatureAndWriteValue method writes the value passed in to the tag or acknowledges the alarm or list of alarms, and sends a signed operator message to the alarm system. This method can only write to FIX32 data sources.

Typically, you call this method when you want to gather signature information through the application, but still want to use the ESignature object to perform signature validation, write to FIX32 data source(s), and send the signed operator message.

You must call the Initialize() method prior to calling this method if you are writing values to the database or acknowledging alarms, otherwise the function fails and an error is returned.

Syntax

object.ValidateSignatureAndWriteValue(nAction, pValue, bstrPerformUsername, bstrPerformPassword, [bstrPerformComment], [bstrVerifyUsername], [bstrVerifyPassword], [bstrVerifyComment])

Properties

The ValidateSignatureAndWriteValue method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

nAction

Integer. Indicates the type of action associated with this signature. Valid entries include:
0 – (WRITE_VAL). Writes a value to a single data source.

3 – (ACK_OR_REMOVE). Acknowledges a single alarm.

4 – (ACK_OR_REMOVE_LIST). Acknowledges multiple alarms.

pValue

Variant. Value to be written to the database.

bstrPerformUsername

String. Performed By user name to be validated.

bstrPerformPassword

String. Performed By password to be validated.

bstrPerformComment

String. (Optional). The performed by comment to be sent with the signed operator message.

bstrVerifyUsername

String. (Optional). Verified By user name to be validated.

bstrVerifyPassword

String. (Optional). Verified By password to be validated.

bstrVerifyComment

String. (Optional). Verified By comment to be sent with the signed operator message.

Return Value

This method returns HRESULT. If the HRESULT is a value other than S_OK, VBA generates an error. You can handle this error using the On Error Statement You can find out more information about the error by using Err Object.

 

Example

Applies To