TElCustomTSPClient.OnTSPError event

TElCustomTSPClient.OnTSPError

This event is fired when timestamping has failed.

Declaration

[C#]
event TSBTSPErrorEvent OnTSPError;
delegate void TSBTSPErrorEvent(Object Sender, int ResultCode, TSBPKIStatus ServerResult, int FailureInfo, string StatusString);

[VB.NET]
Event OnTSPError As TSBTSPErrorEvent
Delegate Sub TSBTSPErrorEvent(ByVal Sender As Object, ByVal ResultCode As Integer, ByVal ServerResult As TSBPKIStatus, Out FailureInfo As Integer, ByVal StatusString as String)

[Pascal]
property OnTSPError : TSBTSPErrorEvent;
TSBTSPErrorEvent = procedure (Sender : TObject; ResultCode : integer; ServerResult: TSBPKIStatus; FailureInfo: integer; StatusString : String) of object;

[C++]
    void get_OnTSPError(TSBTSPErrorEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnTSPError(TSBTSPErrorEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBTSPErrorEvent)(void * _ObjectData, TObjectHandle Sender, int32_t ResultCode, TSBPKIStatus ServerResult, int32_t FailureInfo, const std::string StatusString);

[PHP]
    TSBTSPErrorEvent|callable|NULL get_OnTSPError()
    void set_OnTSPError(TSBTSPErrorEvent|callable|NULL $Value)
    callable TSBTSPErrorEvent(TObject $Sender, integer $ResultCode, integer $ServerResult, integer $FailureInfo, string $StatusString)

[Java]
    TSBTSPErrorEvent getOnTSPError();
    void setOnTSPError(TSBTSPErrorEvent Value);
    TSBTSPErrorEvent.Callback OnTSPError = new TSBTSPErrorEvent.Callback() {
        public void TSBTSPErrorEventCallback(TObject Sender, int ResultCode, TSBPKIStatus ServerResult, int FailureInfo, string StatusString) {
            //...
        }
    }

Parameters

ResultCode - the error code returned by Timestamp method.
ServerResult - request execution result, returned by server. Corresponds to PKIStatus field in the TSP reply structure.
FailureInfo - error information as returned by server
StatusString - optional text message, returned by server. Corresponds to StatusString field in the TSP reply structure.

TSP error codes:

Definition	Value	Description
SB_TSP_ERROR_ABORTED	83969 (0x14801)	Operation aborted
SB_TSP_ERROR_NO_REPLY	83970 (0x14802)	No reply from server
SB_TSP_ERROR_NO_PARAMETERS	83971 (0x14803)	No parameters
SB_TSP_ERROR_NO_CERTIFICATES	83972 (0x14804)	No certificates
SB_TSP_ERROR_WRONG_DATA	83973 (0x14805)	Invalid response data
SB_TSP_ERROR_WRONG_IMPRINT	83974 (0x14806)	Wrong message imprint
SB_TSP_ERROR_WRONG_NONCE	83975 (0x14807)	Wrong nonce from server
SB_TSP_ERROR_UNEXPECTED_CERTIFICATES	83976 (0x14808)	Unexpected certificates
SB_TSP_ERROR_UNRECOGNIZED_FORMAT	81921 (0x14001)	Unrecognized format
SB_TSP_ERROR_DATA_TOO_LONG	81922 (0x14002)	Invalid too long data
SB_TSP_ERROR_UNSUPPORTED_REPLY	81923 (0x14003)	Unsupported reply
SB_TSP_ERROR_GENERAL_ERROR	81924 (0x14004)	General error
SB_TSP_ERROR_REQUEST_REJECTED	81925 (0x14005)	Rejected request

Description

This event is triggered by Timestamp method when the result is non-zero. The event can be used in situations when timestamping is performed by the signature component rather than the application code. In this situation the application can know exactly what happened on timestamping step when it failed.