SendEndResponse Method

Sends an EERP/NERP asynchronously.


ANSI (Cross Platform)
int SendEndResponse(const char* lpszVirtualFileName, const char* lpszVirtualFileDate, const char* lpszDestination, const char* lpszOriginator, const char* lpszCreator, int iReasonCode, const char* lpszReasonText, const char* lpszFileHash, const char* lpszSignature);

Unicode (Windows)
INT SendEndResponse(LPCWSTR lpszVirtualFileName, LPCWSTR lpszVirtualFileDate, LPCWSTR lpszDestination, LPCWSTR lpszOriginator, LPCWSTR lpszCreator, INT iReasonCode, LPCWSTR lpszReasonText, LPCWSTR lpszFileHash, LPCWSTR lpszSignature);
- (void)sendEndResponse:(NSString*)virtualFileName :(NSString*)virtualFileDate :(NSString*)destination :(NSString*)originator :(NSString*)creator :(int)reasonCode :(NSString*)reasonText :(NSString*)fileHash :(NSString*)signature;

IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_OFTPClient_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);


This method sends an EERP/NERP. By default the class will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.

To respond asynchronously first set the SendEndResponse parameter of the EndTransfer event to False. This instructs the class to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

Destination should be set to the SFID of the remote host.

Originator should be set to the SFID of the local system. In the case that the class is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.

Creator should be set to the SFID of the local system.

Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the EndResponse event (if populated).

ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the class will send an EERP. If ReasonCode is set to any non-zero value the class will send a NERP. Common values are:

ReasonCode ReasonText
3 User Code Not Known
4 Invalid Password
9 Unspecified Reason
11 Invalid FileName
12 Invalid Destination
13 Invalid Origin
14 Invalid Storage Record Format
15 Maximum Record Length Not Supported
16 File Size Too Big
20 Invalid Record Count
21 Invalid Byte Count
22 Access Method Failure
23 Duplicate File
24 File Direction Refused
25 Cipher Suite Not Supported
26 Encrypted File Not Allowed
27 Unencrypted File Not Allowed
28 Compression Not Allowed
29 Signed File Not Allowed
30 Unsigned File Not Allowed
31 File Signature Not Valid
32 File Decompression Failed
33 File Decryption Failed
34 File Processing Failed
35 Not Delivered To Recipient
36 Not Acknowledged By Recipient
50 Transmission Stopped By The Operator
90 File Size Incompatible With Recipient's Protocol Version
99 Unspecified Reason

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 C++ Edition - Version 20.0 [Build 8203]