AddHeader Method

Adds a custom header to send with outgoing messages.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int AddHeader(const char* lpszKey, const char* lpszValue);

Unicode (Windows)
INT AddHeader(LPCWSTR lpszKey, LPCWSTR lpszValue);

- (void)addHeader:(NSString*)key :(NSString*)value;

#define MID_STOMP_ADDHEADER 3

IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_STOMP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method is used to add user-defined headers to the list of headers held by the Header* properties.

When SendMessage or SendData is called, all headers in the Header* properties are added to the outgoing message.

Note that the STOMP specification defines a number of standard headers necessary for implementing the STOMP protocol. When constructing an outgoing message, the class silently ignores any user-defined headers that are already set by the class.

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