Object methods (public)

void operator = ( const ImqMessage & msg );

Copies the MQMD and message data from msg. If a buffer has been supplied by the user for this object, the amount of data copied is restricted to the available buffer size. Otherwise, the system ensures that a buffer of adequate size is made available for the copied data.

ImqString applicationIdData( ) const ;

Returns a copy of the application id data.

void setApplicationIdData( const char * data = 0 );

Sets the application id data.

ImqString applicationOriginData( ) const ;

Returns a copy of the application origin data.

void setApplicationOriginData( const char * data = 0 );

Sets the application origin data.

MQLONG backoutCount( ) const ;

Returns the backout count.

MQLONG characterSet( ) const ;

Returns the character set.

void setCharacterSet( const MQLONG ccsid = MQCCSI_Q_MGR );

Sets the character set.

MQLONG encoding( ) const ;

Returns the encoding.

void setEncoding( const MQLONG encoding = MQENC_NATIVE );

Sets the encoding.

MQLONG expiry( ) const ;

Returns the expiry.

void setExpiry( const MQLONG expiry );

Sets the expiry.

ImqString format( ) const ;

Returns a copy of the format, including trailing blanks.

ImqBoolean formatIs( const char * format-to-test ) const ;

Returns TRUE if the format is the same as format-to-test.

void setFormat( const char * name = 0 );

Sets the format, padded to eight characters with trailing blanks.

MQLONG messageFlags( ) const ;

Returns the message flags.

void setMessageFlags( const MQLONG flags );

Sets the message flags.

MQLONG messageType( ) const ;

Returns the message type.

void setMessageType( const MQLONG type );

Sets the message type.

MQLONG offset( ) const ;

Returns the offset.

void setOffset( const MQLONG offset );

Sets the offset.

MQLONG originalLength( ) const ;

Returns the original length.

void setOriginalLength( const MQLONG length );

Sets the original length.

MQLONG persistence( ) const ;

Returns the persistence.

void setPersistence( const MQLONG persistence );

Sets the persistence.

MQLONG priority( ) const ;

Returns the priority.

void setPriority( const MQLONG priority );

Sets the priority.

ImqString putApplicationName( ) const ;

Returns a copy of the put application name.

void setPutApplicationName( const char * name = 0 );

Sets the put application name.

MQLONG putApplicationType( ) const ;

Returns the put application type.

void setPutApplicationType( const MQLONG type = MQAT_NO_CONTEXT );

Sets the put application type.

ImqString putDate( ) const ;

Returns a copy of the put date.

void setPutDate( const char * date = 0 );

Sets the put date.

ImqString putTime( ) const ;

Returns a copy of the put time.

void setPutTime( const char * time = 0 );

Sets the put time.

ImqBoolean readItem( ImqItem & item );

Reads into the item object from the message buffer, using the ImqItem pasteIn method. It returns TRUE if successful.

ImqString replyToQueueManagerName( ) const ;

Returns a copy of the reply-to queue manager name.

void setReplyToQueueManagerName( const char * name = 0 );

Sets the reply-to queue manager name.

ImqString replyToQueueName( ) const ;

Returns a copy of the reply-to queue name.

void setReplyToQueueName( const char * name = 0 );

Sets the reply-to queue name.

MQLONG report( ) const ;

Returns the report.

void setReport( const MQLONG report );

Sets the report.

MQLONG sequenceNumber( ) const ;

Returns the sequence number.

void setSequenceNumber( const MQLONG number );

Sets the sequence number.

size_t totalMessageLength( ) const ;

Returns the total message length.

ImqString userId( ) const ;

Returns a copy of the user id.

void setUserId( const char * id = 0 );

Sets the user id.

ImqBoolean writeItem( ImqItem & item );

Writes from the item object into the message buffer, using the ImqItem copyOut method. Writing can take the form of insertion, replacement, or an append: this depends on the class of the item object. This method returns TRUE if successful.