SetRequestHeader Method

Allows the user to set or add arbitrary HTTP request headers.

Syntax

ANSI (Cross Platform)
int SetRequestHeader(const char* lpszHeaderName, const char* lpszHeaderValue);

Unicode (Windows)
INT SetRequestHeader(LPCWSTR lpszHeaderName, LPCWSTR lpszHeaderValue);

- (void)setRequestHeader:(NSString*)headerName :(NSString*)headerValue;

#define MID_AS2SENDER_SETREQUESTHEADER 11

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

Remarks

HeaderName should contain the header name, and HeaderValue should contain its value. Use this to set headers such as To, Date, etc. Note that a default value for Date will automatically be determined and this method may be used to override the default.

SetRequestHeader may be used to set any header except for the following: AS2-To, AS2-From, AS2-Version, Subject, Message-Id, Disposition-Notification-To, Disposition-Notification-Options, Receipt-Delivery-Option, Host, Content-Length.

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.)

IPWorks EDI 2020 C++ Edition Website Download Support Questions / Feedback?
IPWorks EDI 2020 C++ Edition Introduction Licensing Instructions AS2 Introduction EDI Translation Components AS2ProfileMgr Class Introduction Properties AsyncMDNURL CreateDirStruct DataDir DirDeleted DirIncoming DirLogs DirOutgoing DirPending DirPendingInfo DirSent Email EncryptionCertEncoded EncryptionCertStore EncryptionCertStorePassword EncryptionCertStoreType EncryptionCertSubject OptionCompress OptionEncrypt OptionSign Organization PartnerCount RequestMDN RequestMDNSigned RequestMDNSynchronous RequireEncrypt RequireSign SigningCertEncoded SigningCertStore SigningCertStorePassword SigningCertStoreType SigningCertSubject SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject URL Methods Config DeleteProfile GetProperty GetTPInfo ListPartners ListProperties LoadProfile Reset SaveProfile SetProperty Events Error Partner PartnerDirectory Property Configuration Error Codes AS2Receiver Class Introduction Properties AS2From AS2To AttachmentCount AttachmentContentType AttachmentData AttachmentFilename AttachmentHeaders AttachmentName CEMCount CEMAccepted CEMCertId CEMCertIssuer CEMCertSerialNumber CEMCertStore CEMCertStorePassword CEMCertStoreType CEMCertSubject CEMCertUsage CEMRejectionReason CEMRespondByDate CEMResponseURL CertEncoded CertStore CertStorePassword CertStoreType CertSubject CompressionFormat EDIData EDIType EDIFilename EDIName FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser IncomingDirectory LocalHost LogDirectory LogFile MDNReceiptContent MDNReceiptHeaderCount MDNReceiptHeaderField MDNReceiptHeaderIndex MDNReceiptHeaders MDNReceiptHeaderValue MDNReceiptMDN MDNReceiptMessage MDNReceiptMICValue MDNReceiptSigningProtocol MDNTo MessageId ReceiptDeliveryOption Request RequestHeaderCount RequestHeaderField RequestHeaderValue RequestHeadersString RestartDirectory RolloverCertEncoded RolloverCertStore RolloverCertStorePassword RolloverCertStoreType RolloverCertSubject ScanResult SignerCertEncoded SignerCertStore SignerCertStorePassword SignerCertStoreType SignerCertSubject SSLAcceptServerCertEncoded SSLAcceptServerCertStore SSLAcceptServerCertStorePassword SSLAcceptServerCertStoreType SSLAcceptServerCertSubject SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject UsePSS Methods AckRequest Config CreateMDNReceipt ParseRequest ProcessRequest ProcessRestartRequest ReadRequest Reset SendAsyncMDN SendResponse SetTPInfo Events CEMRequest CEMResponse EDIDataInfo Error Log RecipientInfo SignerCertInfo SSLServerAuthentication SSLStatus Configuration Error Codes AS2Sender Class Introduction Properties AS2From AS2To AS2Version AsyncMDNInfoDir AttachmentCount AttachmentContentType AttachmentData AttachmentFilename AttachmentHeaders AttachmentName CEMCount CEMAccepted CEMCertId CEMCertIssuer CEMCertSerialNumber CEMCertStore CEMCertStorePassword CEMCertStoreType CEMCertSubject CEMCertUsage CEMRejectionReason CEMRespondByDate CEMResponseURL CompressionFormat CookieCount CookieDomain CookieExpiration CookieName CookiePath CookieSecure CookieValue EDIData EDIType EDIFilename EDIName EncryptionAlgorithm Etag FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser From LocalHost LogDirectory LogFile MDNDeliveryOption MDNOptions MDNReceiptContent MDNReceiptHeaderCount MDNReceiptHeaderField MDNReceiptHeaderIndex MDNReceiptHeaders MDNReceiptHeaderValue MDNReceiptMDN MDNReceiptMessage MDNReceiptMICValue MDNReceiptSigningProtocol MDNTo MessageId OriginalContentMIC ProxyAuthScheme ProxyAutoDetect ProxyPassword ProxyPort ProxyServer ProxySSL ProxyUser ReceiptSignerCertEncoded ReceiptSignerCertStore ReceiptSignerCertStorePassword ReceiptSignerCertStoreType ReceiptSignerCertSubject RecipientCertCount RecipientCertEncoded RecipientCertStore RecipientCertStorePassword RecipientCertStoreType RecipientCertSubject RestartDirectory RolloverSigningCertEncoded RolloverSigningCertStore RolloverSigningCertStorePassword RolloverSigningCertStoreType RolloverSigningCertSubject SignatureAlgorithm SigningCertEncoded SigningCertStore SigningCertStorePassword SigningCertStoreType SigningCertSubject SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLServerCertEncoded Subject Timeout URL UseOAEP UsePSS UserAgent Methods Config DoEvents Interrupt Post ReadAsyncReceipt Reset Restart SendCEMRequest SendCEMResponse SetRequestHeader SetTPInfo VerifyReceipt Events Connected Disconnected EndTransfer Error Header Log SetCookie SSLServerAuthentication SSLStatus StartTransfer Transfer Configuration Error Codes CertMgr Class Introduction Properties CertEffectiveDate CertEncoded CertExpirationDate CertExtendedKeyUsage CertFingerprint CertIssuer CertKeyPassword CertPrivateKey CertPrivateKeyAvailable CertPrivateKeyContainer CertPublicKey CertPublicKeyAlgorithm CertPublicKeyLength CertSerialNumber CertSignatureAlgorithm CertSubject CertSubjectAltNames CertThumbprintMD5 CertThumbprintSHA1 CertThumbprintSHA256 CertUsage CertUsageFlags CertVersion CertExtensionCount CertExtensionCritical CertExtensionOID CertExtensionValue CertStore CertStorePassword CertStoreType ExportedCert ExportFormat ExportPrivateKey Methods Config CreateCertificate CreateKey DeleteCertificate DeleteKey ExportCertificate GenerateCSR ImportCertificate ImportSignedCSR IssueCertificate ListCertificateStores ListKeys ListMachineStores ListStoreCertificates ReadCertificate ReadCSR Reset SaveCertificate ShowCertificateChain SignCSR Events CertChain CertList Error KeyList Log StoreList Configuration Error Codes EDIFACTReader Class Introduction Properties BuildDOM EDIStandardVersion ExtraData InputData InputFile Offset SchemaFormat XChildren ElementCount ElementComponentCount ElementComponentIndex ElementComponentName ElementComponentSchemaDesc ElementComponentSchemaName ElementComponentType ElementComponentValue ElementDataType ElementName ElementRepeatCount ElementRepeatIndex ElementSchemaDesc ElementSchemaName ElementValue XPath XSegment XSegmentNumber XSegmentType XTag XTransactionCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush GenerateAck HasXPath LoadSchema Parse Reset TryXPath Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes EDIFACTTranslator Class Introduction Properties InputData InputFile InputFormat OutputData OutputFile OutputFormat Overwrite RenamingRule RenamingRuleCount RenamingRuleIndex SchemaFormat Suffix UseSchemaName Methods AddRenamingRule Config DisplaySchemaInfo ExportXMLSchema GenerateAck LoadRenamingRules LoadSchema Reset SaveRenamingRules Translate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes EDIFACTValidator Class Introduction Properties EDIStandardVersion InputData InputFile SchemaFormat ValidationErrorCount ValidationErrorColumn ValidationErrorElementErrorCode ValidationErrorElementPosition ValidationErrorErrorCode ValidationErrorLine ValidationErrorMessage ValidationErrorSegmentErrorCode ValidationErrorSegmentNumber ValidationErrorSegmentTag ValidationErrorTechnicalErrorCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush LoadSchema Reset Validate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction ValidationError Configuration Error Codes EDIFACTWriter Class Introduction Properties FileWriteMode OutputData OutputFile SchemaFormat Suffix Methods CompileSchema Config CreateFunctionalGroupFooter CreateInterchangeFooter CreateTransactionFooter DisplaySchemaInfo EndElement EndSegment Flush LoadSchema RepeatElement Reset SkipComponent SkipElement StartElement StartFunctionalGroupHeader StartInterchangeHeader StartSegment StartTransactionHeader WriteComponentString WriteElementString WriteTransaction Events Error Output Warning Configuration Error Codes FTP Class Introduction Properties Account Command Connected DirListCount DirListEntry DirListFileName DirListFileSize DirListFileTime DirListIsDir DirListIsSymlink FileExists FileSize FileTime FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Idle LastReply LocalFile LocalHost Overwrite Passive Password RemoteFile RemoteHost RemotePath RemotePort SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode StartByte Timeout TransferMode User Methods Abort Append Config DeleteFile DoEvents Download Interrupt ListDirectory ListDirectoryLong Logoff Logon MakeDirectory RemoveDirectory RenameFile Reset SetDownloadStream SetUploadStream StoreUnique Upload Events ConnectionStatus DirList EndTransfer Error PITrail SSLServerAuthentication SSLStatus StartTransfer Transfer Types IPWorksEDIStream Configuration Error Codes HL7Reader Class Introduction Properties BuildDOM EDIStandardVersion ExtraData InputData InputFile Offset SchemaFormat XChildren ElementCount ElementComponentCount ElementComponentIndex ElementComponentName ElementComponentSchemaDesc ElementComponentSchemaName ElementComponentType ElementComponentValue ElementDataType ElementName ElementRepeatCount ElementRepeatIndex ElementSchemaDesc ElementSchemaName ElementValue XPath XSegment XSegmentNumber XSegmentType XTag XTransactionCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush GenerateAck HasXPath LoadSchema Parse Reset TryXPath Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes HL7Translator Class Introduction Properties InputData InputFile InputFormat OutputData OutputFile OutputFormat Overwrite RenamingRule RenamingRuleCount RenamingRuleIndex SchemaFormat Suffix UseSchemaName Methods AddRenamingRule Config DisplaySchemaInfo ExportXMLSchema GenerateAck LoadRenamingRules LoadSchema Reset SaveRenamingRules Translate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes HL7Validator Class Introduction Properties EDIStandardVersion InputData InputFile SchemaFormat ValidationErrorCount ValidationErrorColumn ValidationErrorElementErrorCode ValidationErrorElementPosition ValidationErrorErrorCode ValidationErrorLine ValidationErrorMessage ValidationErrorSegmentErrorCode ValidationErrorSegmentNumber ValidationErrorSegmentTag ValidationErrorTechnicalErrorCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush LoadSchema Reset Validate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction ValidationError Configuration Error Codes HL7Writer Class Introduction Properties FileWriteMode OutputData OutputFile SchemaFormat Suffix Methods CompileSchema Config CreateFunctionalGroupFooter CreateInterchangeFooter CreateTransactionFooter DisplaySchemaInfo EndElement EndSegment Flush LoadSchema RepeatElement Reset SkipComponent SkipElement StartElement StartFunctionalGroupHeader StartInterchangeHeader StartSegment StartTransactionHeader WriteComponentString WriteElementString WriteTransaction Events Error Output Warning Configuration Error Codes HTMLMailer Class Introduction Properties AttachmentCount AttachmentFile AttachmentName AuthMechanism BCc Cc Command Connected DeliveryNotificationTo FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser From HTMLFile Idle ImageCount ImageData ImageFile ImageId ImageType Importance LastReply LocalHost MailPort MailServer MessageDate MessageHTML MessageId MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageText OtherHeaders ParseHTML Password Priority ReadReceiptTo ReplyTo SendTo Sensitivity SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Subject Timeout User Methods AddAttachment Config Connect Disconnect DoEvents Interrupt ProcessQueue Queue Reset ResetHeaders Send SetMessageHTMLStream Events ConnectionStatus EndTransfer Error PITrail SSLServerAuthentication SSLStatus StartTransfer Transfer Types IPWorksEDIStream Configuration Error Codes IMAP Class Introduction Properties AuthMechanism AutoDecodeParts Command Connected EndByte FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Idle LastReply LocalFile LocalHost Mailbox MailboxFlags MailboxListCount MailboxListFlags MailboxListName MailboxListSeparator MailPort MailServer Message MessageContentEncoding MessageContentType MessageCount MessageDate MessageDeliveryTime MessageFlags MessageFrom MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString MessageId MessageInfoCount MessageInfoDate MessageInfoFlags MessageInfoFrom MessageInfoMessageId MessageInfoSize MessageInfoSubject MessageInReplyTo MessageNetId MessagePartCount MessagePartContentDisposition MessagePartContentEncoding MessagePartContentId MessagePartContentType MessagePartFilename MessagePartId MessagePartMultipartMode MessagePartParameters MessagePartSize MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageReplyTo MessageSender MessageSet MessageSize MessageSubject MessageText Overwrite Password PeekMode RecentMessageCount SortCriteria SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode StartByte Timeout UIDMode UIDValidity User Methods AddMessageFlags AppendToMailbox CheckMailbox CloseMailbox Config Connect CopyToMailbox CreateMailbox DeleteFromMailbox DeleteMailbox DeleteMailboxACL Disconnect DoEvents ExamineMailbox ExpungeMailbox FetchMessageHeaders FetchMessageInfo FetchMessagePart FetchMessagePartHeaders FetchMessageText GetMailboxACL Interrupt ListMailboxes ListSubscribedMailboxes LocalizeDate MoveToMailbox Noop RenameMailbox Reset ResetMessageFlags SearchMailbox SelectMailbox SetMailboxACL SetMessageStream StartIdle StopIdle SubscribeMailbox UnsetMessageFlags UnsubscribeMailbox Events ConnectionStatus EndTransfer Error Header IdleInfo MailboxACL MailboxList MessageInfo MessagePart PITrail SSLServerAuthentication SSLStatus StartTransfer Transfer Types IPWorksEDIStream Configuration Error Codes MLLPClient Class Introduction Properties Connected FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser InputData InputFilename KeepAlive LocalHost LocalPort OutputData OutputFilename RemoteHost RemotePort SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout Version Methods Config Connect Disconnect DoEvents Interrupt Reset Send Events AckIn AckOut Connected ConnectionStatus Disconnected EndTransfer Error Log SSLServerAuthentication SSLStatus StartTransfer Transfer Configuration Error Codes MLLPServer Class Introduction Properties ConnectionCount Connected ConnectionId InputData InputFilename LocalAddress OutputData OutputFilename RemoteHost RemotePort Timeout DefaultTimeout KeepAlive Listening LocalHost LocalPort SSLAuthenticateClients SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled Version Methods Config Disconnect DoEvents Interrupt Reset Send Shutdown Events AckIn AckOut Connected ConnectionRequest Disconnected EndTransfer Error Log SSLClientAuthentication SSLConnectionRequest SSLStatus StartTransfer Transfer Configuration Error Codes OFTPClient Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject ClientPassword ClientSFIDCode ClientSSIDCode Compress Connected DownloadDirectory EncryptionAlgorithm FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser LocalHost MaxRecordSize Overwrite RecipientCertEncoded RecipientCertStore RecipientCertStorePassword RecipientCertStoreType RecipientCertSubject RemoteHost RemotePort SecureAuthentication ServerPassword ServerSFIDCode ServerSSIDCode SignedReceipt SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject Timeout TrustedCertCount TrustedCertEncoded TrustedCertStore TrustedCertStorePassword TrustedCertStoreType TrustedCertSubject UseSSL Version VirtualFileDate VirtualFileFormat VirtualFileSecurityLevel Methods ChangeDirection Config DoEvents ExchangeCertificate ImportTrustedCerts Interrupt Logoff Logon ReceiveFiles Reset SendEndResponse SendFile Events AcceptFile CertificateReceived EndResponse EndTransfer Error PITrail SSLServerAuthentication SSLStatus StartTransfer Transfer Configuration Error Codes OFTPServer Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject ConnectionBacklog OFTPConnectionCount OFTPConnectionCompress OFTPConnectionConnected OFTPConnectionConnectionId OFTPConnectionDownloadDirectory OFTPConnectionEncryptionAlgorithm OFTPConnectionLocalAddress OFTPConnectionMaxRecordSize OFTPConnectionReadyToSend OFTPConnectionRecipientCertStore OFTPConnectionRecipientCertStorePassword OFTPConnectionRecipientCertStoreType OFTPConnectionRecipientCertSubject OFTPConnectionRemoteHost OFTPConnectionRemotePort OFTPConnectionSFIDCode OFTPConnectionSignedReceipt OFTPConnectionSSIDCode OFTPConnectionTimeout OFTPConnectionVersion OFTPConnectionVirtualFileDate OFTPConnectionVirtualFileFormat OFTPConnectionVirtualFileSecurityLevel DefaultTimeout Listening LocalHost LocalPort ServerPassword ServerSFIDCode ServerSSIDCode SSLAuthenticateClients SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject TrustedCertCount TrustedCertEncoded TrustedCertStore TrustedCertStorePassword TrustedCertStoreType TrustedCertSubject UseSSL Methods ChangeDirection Config Disconnect DoEvents ExchangeCertificate ImportTrustedCerts Interrupt Logoff Reset SendEndResponse SendFile Shutdown Events AcceptConnection AcceptFile CertificateReceived Connected ConnectionRequest Disconnected EndResponse EndTransfer Error PITrail ReadyToSend SSLClientAuthentication SSLConnectionRequest SSLStatus StartTransfer Transfer Configuration Error Codes POP Class Introduction Properties AuthMechanism Command Connected FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Idle IncludeHeaders LastReply LocalFile LocalHost MailPort MailServer MaxLines Message MessageCc MessageCount MessageDate MessageFrom MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString MessageNumber MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageReplyTo MessageSize MessageSubject MessageText MessageTo MessageUID Password SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Timeout TotalSize User Methods Config Connect Delete Disconnect DoEvents Interrupt ListMessageSizes ListMessageUIDs LocalizeDate Reset Retrieve RetrieveHeaders SetMessageStream Events ConnectionStatus EndTransfer Error Header MessageList PITrail SSLServerAuthentication SSLStatus StartTransfer Transfer Types IPWorksEDIStream Configuration Error Codes SFTP Class Introduction Properties Connected DirListCount DirListEntry DirListFileName DirListFileSize DirListFileTime DirListIsDir DirListIsSymlink FileAccessTime FileACL FileAllocationSize FileAttributeBits FileAttributeBitsValid FileCreationTime FileType FileGroupId FileIsDir FileIsSymlink FileModifiedTime FileOwnerId FilePermissions FilePermissionsOctal FileSize FileExists FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Idle LocalFile LocalHost LocalPort Overwrite RemoteFile RemotePath SSHAcceptServerHostKeyEncoded SSHAuthMode SSHCertEncoded SSHCertStore SSHCertStorePassword SSHCertStoreType SSHCertSubject SSHCompressionAlgorithms SSHEncryptionAlgorithms SSHHost SSHPassword SSHPort SSHUser StartByte Timeout Methods Append Config CreateFile DecodePacket DeleteFile DoEvents Download EncodePacket GetSSHParam GetSSHParamBytes Interrupt ListDirectory MakeDirectory QueueFile RemoveDirectory RenameFile Reset ResetQueue SetDownloadStream SetSSHParam SetUploadStream SSHLogoff SSHLogon UpdateFileAttributes Upload Events Connected ConnectionStatus DirList Disconnected EndTransfer Error Log SSHCustomAuth SSHKeyboardInteractive SSHServerAuthentication SSHStatus StartTransfer Transfer Types IPWorksEDIStream Configuration Error Codes SMTP Class Introduction Properties AllowExtensions AuthMechanism BCc Cc Command Connected DeliveryNotificationTo FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser From Idle Importance LastReply LocalHost MailPort MailServer Message MessageDate MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString MessageId MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageText OtherHeaders Password Priority ReadReceiptTo ReplyTo ReturnPath SendTo Sensitivity SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Subject Timeout User Methods Config Connect Disconnect DoEvents Expand Interrupt ProcessQueue Queue Reset ResetHeaders Send SendToTerminalAndEmail SendToTerminalOnly SendToTerminalOrEmail SetMessageStream Verify Events ConnectionStatus EndTransfer Error Expand PITrail SSLServerAuthentication SSLStatus StartTransfer Transfer Types IPWorksEDIStream Configuration Error Codes TRADACOMSReader Class Introduction Properties BuildDOM EDIStandardVersion ExtraData InputData InputFile Offset SchemaFormat XChildren ElementCount ElementComponentCount ElementComponentIndex ElementComponentName ElementComponentSchemaDesc ElementComponentSchemaName ElementComponentType ElementComponentValue ElementDataType ElementName ElementRepeatCount ElementRepeatIndex ElementSchemaDesc ElementSchemaName ElementValue XPath XSegment XSegmentNumber XSegmentType XTag XTransactionCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush GenerateAck HasXPath LoadSchema Parse Reset TryXPath Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes TRADACOMSTranslator Class Introduction Properties InputData InputFile InputFormat OutputData OutputFile OutputFormat Overwrite RenamingRule RenamingRuleCount RenamingRuleIndex SchemaFormat Suffix UseSchemaName Methods AddRenamingRule Config DisplaySchemaInfo ExportXMLSchema GenerateAck LoadRenamingRules LoadSchema Reset SaveRenamingRules Translate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes TRADACOMSValidator Class Introduction Properties EDIStandardVersion InputData InputFile SchemaFormat ValidationErrorCount ValidationErrorColumn ValidationErrorElementErrorCode ValidationErrorElementPosition ValidationErrorErrorCode ValidationErrorLine ValidationErrorMessage ValidationErrorSegmentErrorCode ValidationErrorSegmentNumber ValidationErrorSegmentTag ValidationErrorTechnicalErrorCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush LoadSchema Reset Validate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction ValidationError Configuration Error Codes TRADACOMSWriter Class Introduction Properties FileWriteMode OutputData OutputFile SchemaFormat Suffix Methods CompileSchema Config CreateFunctionalGroupFooter CreateInterchangeFooter CreateTransactionFooter DisplaySchemaInfo EndElement EndSegment Flush LoadSchema RepeatElement Reset SkipComponent SkipElement StartElement StartFunctionalGroupHeader StartInterchangeHeader StartSegment StartTransactionHeader WriteComponentString WriteElementString WriteTransaction Events Error Output Warning Configuration Error Codes VDAReader Class Introduction Properties BuildDOM EDIStandardVersion ExtraData InputData InputFile Offset SchemaFormat XChildren ElementCount ElementComponentCount ElementComponentIndex ElementComponentName ElementComponentSchemaDesc ElementComponentSchemaName ElementComponentType ElementComponentValue ElementDataType ElementName ElementRepeatCount ElementRepeatIndex ElementSchemaDesc ElementSchemaName ElementValue XPath XSegment XSegmentNumber XSegmentType XTag XTransactionCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush GenerateAck HasXPath LoadSchema Parse Reset TryXPath Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes VDATranslator Class Introduction Properties InputData InputFile InputFormat OutputData OutputFile OutputFormat Overwrite RenamingRule RenamingRuleCount RenamingRuleIndex SchemaFormat Suffix UseSchemaName Methods AddRenamingRule Config DisplaySchemaInfo ExportXMLSchema GenerateAck LoadRenamingRules LoadSchema Reset SaveRenamingRules Translate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes VDAValidator Class Introduction Properties EDIStandardVersion InputData InputFile SchemaFormat ValidationErrorCount ValidationErrorColumn ValidationErrorElementErrorCode ValidationErrorElementPosition ValidationErrorErrorCode ValidationErrorLine ValidationErrorMessage ValidationErrorSegmentErrorCode ValidationErrorSegmentNumber ValidationErrorSegmentTag ValidationErrorTechnicalErrorCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush LoadSchema Reset Validate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction ValidationError Configuration Error Codes VDAWriter Class Introduction Properties FileWriteMode OutputData OutputFile SchemaFormat Suffix Methods CompileSchema Config CreateFunctionalGroupFooter CreateInterchangeFooter CreateTransactionFooter DisplaySchemaInfo EndElement EndSegment Flush LoadSchema RepeatElement Reset SkipComponent SkipElement StartElement StartFunctionalGroupHeader StartInterchangeHeader StartSegment StartTransactionHeader WriteComponentString WriteElementString WriteTransaction Events Error Output Warning Configuration Error Codes X12Reader Class Introduction Properties BuildDOM EDIStandardVersion ExtraData InputData InputFile Offset SchemaFormat XChildren ElementCount ElementComponentCount ElementComponentIndex ElementComponentName ElementComponentSchemaDesc ElementComponentSchemaName ElementComponentType ElementComponentValue ElementDataType ElementName ElementRepeatCount ElementRepeatIndex ElementSchemaDesc ElementSchemaName ElementValue XPath XSegment XSegmentNumber XSegmentType XTag XTransactionCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush GenerateAck HasXPath LoadSchema Parse Reset TryXPath Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes X12Translator Class Introduction Properties InputData InputFile InputFormat OutputData OutputFile OutputFormat Overwrite RenamingRule RenamingRuleCount RenamingRuleIndex SchemaFormat Suffix UseSchemaName Methods AddRenamingRule Config DisplaySchemaInfo ExportXMLSchema GenerateAck LoadRenamingRules LoadSchema Reset SaveRenamingRules Translate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction Warning Configuration Error Codes X12Validator Class Introduction Properties EDIStandardVersion InputData InputFile SchemaFormat ValidationErrorCount ValidationErrorColumn ValidationErrorElementErrorCode ValidationErrorElementPosition ValidationErrorErrorCode ValidationErrorLine ValidationErrorMessage ValidationErrorSegmentErrorCode ValidationErrorSegmentNumber ValidationErrorSegmentTag ValidationErrorTechnicalErrorCode Methods CompileSchema Config DisplaySchemaInfo DisplayXMLInfo Flush LoadSchema Reset Validate Events EndFunctionalGroup EndInterchange EndLoop EndTransaction Error ResolveSchema Segment StartFunctionalGroup StartInterchange StartLoop StartTransaction ValidationError Configuration Error Codes X12Writer Class Introduction Properties FileWriteMode OutputData OutputFile SchemaFormat Suffix Methods CompileSchema Config CreateFunctionalGroupFooter CreateInterchangeFooter CreateTransactionFooter DisplaySchemaInfo EndElement EndSegment Flush LoadSchema RepeatElement Reset SkipComponent SkipElement StartElement StartFunctionalGroupHeader StartInterchangeHeader StartSegment StartTransactionHeader WriteComponentString WriteElementString WriteTransaction Events Error Output Warning Configuration Error Codes Software License	SetRequestHeader Method Allows the user to set or add arbitrary HTTP request headers. Syntax C++ Objective-C C ANSI (Cross Platform) int SetRequestHeader(const char* lpszHeaderName, const char* lpszHeaderValue); Unicode (Windows) INT SetRequestHeader(LPCWSTR lpszHeaderName, LPCWSTR lpszHeaderValue); - (void)setRequestHeader:(NSString)headerName :(NSString)headerValue; #define MID_AS2SENDER_SETREQUESTHEADER 11** IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_AS2Sender_Do(void lpObj, int methid, int cparam, void param[], int cbparam[], int64 lpllVal); Remarks HeaderName* should contain the header name, and HeaderValue should contain its value. Use this to set headers such as To, Date, etc. Note that a default value for Date will automatically be determined and this method may be used to override the default. SetRequestHeader may be used to set any header except for the following: AS2-To, AS2-From, AS2-Version, Subject, Message-Id, Disposition-Notification-To, Disposition-Notification-Options, Receipt-Delivery-Option, Host, Content-Length. 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]

IPWorks EDI 2020 C++ Edition

SetRequestHeader Method

Syntax

Remarks

Error Handling (C++)

Questions / Feedback?