3.2. JMS

3.2.1. 標準インタフェース

WebOTX JMSでは、サンマイクロシステムズ社発行の「JavaTM Message Service Version 1.1」で定義されている標準のインタフェースを提供しています。

Java Mesage Service Version1.1

3.2.2. 拡張インタフェース

WebOTX JMSでは、以下のパッケージを提供しています。

3.2.2.1. com.nec.webotx.messaging パッケージ

3.2.2.2. com.nec.webotx.messaging.jmq.jmsclient パッケージ

3.2.2.3. com.nec.webotx.messaging.jms パッケージ

3.2.2.4. com.nec.webotx.messaging.jms.notification パッケージ

3.2.2.1. com.nec.webotx.messaging パッケージ

com.nec.webotx.messaging パッケージは、WebOTX JMS固有のインタフェースを提供します。

3.2.2.1.1. ClientQueueConnection インタフェース

3.2.2.1.2. ClientTopicConnection インタフェース

3.2.2.1.3. ClientSession インタフェース


3.2.2.1.1. ClientQueueConnection インタフェース
com.nec.webotx.messaging.ClientQueueConnection インタフェースは、javax.jms.QueueConnection のメッセージ再配信遅延時間設定の拡張機能を提供します。 拡張メソッドを呼び出す場合、キャストして呼び出してください。
 
createQueueSession メッセージ再配信遅延時間を設定してQueueSessionを生成する

3.2.2.1.1.1. createQueueSession
名称 createQueueConnection − メッセージ再配信遅延時間を設定してQueueSessionを作成する。
形式 package com.nec.webotx.messaging; 

public class  ClientQueueConnection { 
    public QueueSession createQueueSession( 
        boolean transacted, 
        int acknowledgeMode, 
        int redeliverytime
    ); 
}
説明 transactedにはトランザクション制御を行うかどうか、acknowledgeModeには確認応答モードを指定します。 redeliverytimeにメッセージ再配信遅延時間を相対時間(秒)で指定します。このメソッドを使って生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。
戻り値 javax.jms.QueueSession
エラー javax.jms.JMSException


3.2.2.1.2. ClientTopicConnection インタフェース
com.nec.webotx.messaging.ClientTopicConnection インタフェースは、javax.jms.TopicConnection のメッセージ再配信遅延時間設定の拡張機能を提供します。 拡張メソッドを呼び出す場合、キャストして呼び出してください。
 
createTopicSession メッセージ再配信遅延時間を設定してTopicSessionを生成する

3.2.2.1.2.1. createTopicSession
名称 createTopicSession − メッセージ再配信遅延時間を設定してTopicSessionを作成する。
形式 package com.nec.webotx.messaging; 

public class  ClientTopicConnection { 
    public TopicSession createTopicSession( 
        boolean transacted, 
        int acknowledgeMode, 
        int redelaytime
    ); 
}
説明 transactedにトランザクション制御を行うかどうか、acknowledgeModeに確認応答モードを指定します。 redeliverytimeにメッセージ再配信遅延時間を相対時間(秒)で指定します。このメソッドを使って生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。
戻り値 javax.jms.TopicSession
エラー javax.jms.JMSException


3.2.2.1.3. ClientSession インタフェース
com.nec.webotx.messaging.ClientSession インタフェースは、javax.jms.Session の拡張機能を提供します。

NO_ACKNOWLEDGE 確認応答なしモード


3.2.2.1.3.1. NO_ACKNOWLEDGE
名称 NO_ACKNOWLEDGE − 確認応答なしモードをあらわす変数。
形式 package com.nec.webotx.messaging; 

public interface  ClientSession { 
    public static final int  NO_ACKNOWLEDGE = 4; 
};
説明 Session オブジェクトを生成するときのacknowledgeModeに使用します。 確認応答なしモードのSession オブジェクトを生成するときに指定してください。


3.2.2.2. com.nec.webotx.messaging.jmq.jmsclient パッケージ

com.nec.webotx.messaging.jmq.jmsclient パッケージは、WebOTX JMS固有のインタフェースを提供します。

3.2.2.2.1. MessageImpl クラス


3.2.2.2.1. MessageImpl クラス

com.nec.webotx.messaging.jmq.jmsclient.MessageImplクラスは、Messageの配信時刻指定の拡張機能を提供します。
インタフェースjavax.jms.MessageのWebOTX JMSでの実装クラスです。拡張メソッドを呼び出す場合、キャストして呼び出してください。

setDeliveryTime(int) メッセージ配信遅延時間を相対時間(秒)で指定する
setDeliveryTime(java.util.Date) メッセージ配信遅延時間を絶対時刻(java.util.Date)で指定する

3.2.2.2.1.1. setDeliveryTime
名称 setDeliveryTime − Messageの配信遅延時間を相対時間(秒)で指定する
形式 package com.nec.webotx.messaging.jmq.jmsclient; 

public class  MessageImpl { 
    public void setDeliveryTime(int delaytime); 
}
説明 delaytimeにMessage配信遅延時間を相対時間(秒）で指定します。メッセージ送信処理実行後、 実際にコンシューマに配信されるのはdelaytime時間経過した後になります。
戻り値 ありません。
エラー
 ありません。

3.2.2.2.1.2. setDeliveryTime
名称 setDeliveryTime − Messageの配信遅延時間を絶対時刻(java.util.Date)で指定する
形式 package com.nec.webotx.messaging.jmq.jmsclient; 

public class  MessageImpl { 
    public void setDeliveryTime(java.util.Date date); 
}
説明 dateにMessage配信遅延時間を絶対時刻(java.util.Date)で指定します。メッセージ送信処理実行後、 実際にコンシューマに配信されるのはdateで指定した時刻になります。
戻り値 ありません。
エラー ありません。


3.2.2.3. com.nec.webotx.messaging.jms パッケージ

com.nec.webotx.messaging.jms パッケージは、WebOTX JMS固有のインタフェースを提供します。

3.2.2.3.1. Connection インタフェース


3.2.2.3.1. Connection インタフェース
com.nec.webotx.messaging.jms.Connection インタフェースは、javax.jms.Connection のメッセージ再配信遅延時間設定や、イベント通知のためのリスナ設定などの拡張機能を提供します。拡張メソッドを呼び出す場合、キャストして呼び出してください。
createSession メッセージ再配信遅延時間を設定してSessionを生成する
setEventListener コネクションにコネクションイベントリスナを設定する
setConsumerEventListener コネクションにコンシューマイベントリスナを設定する
removeConsumerEventListener コネクションからコンシューマイベントリスナを削除する

3.2.2.3.1.1.createSession
名称 createSession − メッセージ再配信遅延時間を設定してSessionを生成する
形式 package com.nec.webotx.messaging.jms;

public interface Connection extends javax.jms.Connection {
    public Session createSession(
        boolean transacted,
        int acknowledgeMode,
        int redeliverytime
    ) throws javax.jms.JMSException;
}
説明 transactedにはトランザクション制御を行うかどうか、acknowledgeModeには確認応答モードを指定します。 redeliverytimeにメッセージ再配信遅延時間を相対時間(秒)で指定します。このメソッドを使って生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。
戻り値 javax.jms.Session
エラー
 javax.jms.JMSException

3.2.2.3.1.2.setEventListener
名称 setEventListener − コネクションにコネクションイベントリスナを設定する
形式 package com.nec.webotx.messaging.jms;

public interface Connection extends javax.jms.Connection {
    public void setEventListener (
        com.nec.webotx.messaging.jms.notification.EventListener listener
    ) throws javax.jms.JMSException;
}
説明 コネクションクローズや、コネクション再接続に関するイベントが発生した場合に動作する、コネクションイベントリスナを設定します。 listenerには、このコネクションに設定する、コネクションイベントリスナを指定します。
戻り値 ありません。
エラー
 javax.jms.JMSException

3.2.2.3.1.3.setConsumerEventListener
名称 setConsumerEventListener − コネクションにコンシューマイベントリスナを設定する
形式 package com.nec.webotx.messaging.jms;

public interface Connection extends javax.jms.Connection {
    public void setConsumerEventListener (
        com.nec.webotx.messaging.Destination dest,
        com.nec.webotx.messaging.jms.notification.EventListener listener
    ) throws javax.jms.JMSException;
}
説明 送信先に対するコンシューマの有無のイベント通知を受けたときに動作する、コンシューマイベントリスナを設定します。 destには、コンシューマイベント通知の受信対象となる送信先を指定します。 listenerには、このコネクションに設定する、コンシューマイベントリスナを指定します。
戻り値 ありません。
エラー
 javax.jms.JMSException

3.2.2.3.1.4.removeConsumerEventListener
名称 removeConsumerEventListener − コネクションからコンシューマイベントリスナを削除する
形式 package com.nec.webotx.messaging.jms;

public interface Connection extends javax.jms.Connection {
    public void removeConsumerEventListener (
        com.nec.webotx.messaging.Destination dest
    ) throws javax.jms.JMSException;
}
説明 送信先に対するコンシューマイベントリスナを削除します。 destにはコンシューマイベントリスナを削除する送信先を指定します。
戻り値 ありません。
エラー
 javax.jms.JMSException


3.2.2.4. com.nec.webotx.messaging.jms.notification パッケージ

com.nec.webotx.messaging.jms.notification パッケージは、WebOTX JMS固有のイベント通知に関するインタフェースを提供します。

3.2.2.4.1. ConnectionClosedEvent クラス

3.2.2.4.2. ConnectionReconnectedEvent クラス

3.2.2.4.3. ConnectionReconnectFailedEvent クラス

3.2.2.4.4. ConsumerEvent クラス


3.2.2.4.1. ConnectionClosedEvent クラス
com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent クラスは、コネクションのクローズに関するイベントを表します。
getEventCode イベントコードを取得する
getEventMessage イベントメッセージを取得する
getBrokerAddress コネクションの接続先JMSサーバのアドレスを取得する
getConnection イベントと関連付けられているコネクションを取得する
getJMSException コネクションのクローズ原因となったJMSExceptionを取得する
CONNECTION_CLOSED_ERROR JMSサーバ側のエラーによるクローズを示す定数
CONNECTION_CLOSED_KILL 管理者がコネクションをクローズしたことを示す定数
CONNECTION_CLOSED_LOST_CONNECTION ネットワークやJMSサーバ異常によるコネクションのクローズを示す定数
CONNECTION_CLOSED_SHUTDOWN 管理者がJMSサーバをシャットダウンしたことによるクローズを示す定数

3.2.2.4.2.1. getEventCode
名称 getEventCode − イベントコードを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public String getEventCode();
}
説明 このイベントのイベントコードを取得します。ConnectionClosedEventでは、次のいずれかの値が返却されます。
ConnectionClosedEvent.CONNECTION_CLOSED_ERROR
ConnectionClosedEvent.CONNECTION_CLOSED_KILL
ConnectionClosedEvent.CONNECTION_CLOSED_LOST_CONNECTION
ConnectionClosedEvent.CONNECTION_CLOSED_SHUTDOWN
戻り値 String
エラー
 ありません。

3.2.2.4.2.2. getEventMessage
名称 getEventMessage − イベントメッセージを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public String getEventMessage();
}
説明 このイベントのイベントメッセージを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.2.3. getBrokerAddress
名称 getBrokerAddress − コネクションの接続先JMSサーバのアドレスを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public String getBrokerAddress();
}
説明 コネクションが接続していたJMSサーバのアドレスを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.2.4. getConnection
名称 getConnection − イベントを受信したコネクションを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public javax.jms.Connection getConnection();
}
説明 このイベントに関連付けられているコネクションを取得します。
戻り値 javax.jms.Connection
エラー
 ありません。

3.2.2.4.2.5. getJMSException
名称 getJMSException − コネクションのクローズ原因となったJMSExceptionを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public javax.jms.JMSException getJMSException();
}
説明 コネクションがクローズされる原因となったJMSException例外オブジェクトを取得します。
戻り値 javax.jms.JMSException
エラー
 ありません。

3.2.2.4.2.6. CONNECTION_CLOSED_ERROR
名称 CONNECTION_CLOSED_ERROR − JMSサーバ側のエラーによるクローズを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public static final String CONNECTION_CLOSED_ERROR = "E203";
}
説明 ConnectionClosedEventのイベントコードです。 JMSサーバ側のエラー(OutOfMemoryErrorなど)により、コネクションがクローズしたことを示します。
関連項目
 com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()

3.2.2.4.2.7. CONNECTION_CLOSED_KILL
名称 CONNECTION_CLOSED_KILL − 管理者がコネクションをクローズしたことを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public static final String CONNECTION_CLOSED_KILL = "E204";
}
説明 ConnectionClosedEventのイベントコードです。 管理者が運用管理操作によりコネクションをクローズしたことを示します。
関連項目
 com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()

3.2.2.4.2.8. CONNECTION_CLOSED_LOST_CONNECTION
名称 CONNECTION_CLOSED_LOST_CONNECTION − ネットワークやJMSサーバ異常によるコネクションのクローズを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public static final String CONNECTION_CLOSED_LOST_CONNECTION = "E206";
}
説明 ConnectionClosedEventのイベントコードです。 ネットワークの問題や、JMSサーバプロセスの異常終了、または、内部エラーによりコネクションがクローズしたことを示します。
関連項目
 com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()

3.2.2.4.2.9. CONNECTION_CLOSED_SHUTDOWN
名称 CONNECTION_CLOSED_SHUTDOWN − 管理者がJMSサーバをシャットダウンしたことによるクローズを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionClosedEvent {
    public static final String CONNECTION_CLOSED_SHUTDOWN = "E201";
}
説明 ConnectionClosedEventのイベントコードです。 管理者による停止要求によりコネクションがクローズしたことを示します。
関連項目
 com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()

3.2.2.4.2. ConnectionReconnectedEvent クラス
com.nec.webotx.messaging.jms.notification.ConnectionReconnectedEvent クラスは、コネクションの再接続に関するイベントを表します。
getEventCode イベントコードを取得する
getEventMessage イベントメッセージを取得する
getBrokerAddress コネクションの再接続先JMSサーバのアドレスを取得する
getConnection イベントと関連付けられているコネクションを取得する
CONNECTION_RECONNECTED コネクションが再接続したことを示す定数

3.2.2.4.2.1. getEventCode
名称 getEventCode − イベントコードを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectedEvent {
    public String getEventCode();
}
説明 このイベントのイベントコードを取得します。ConnectionReconnectedEventでは、次の値が返却されます。
ConnectionReconnectedEvent.CONNECTION_RECONNECTED
戻り値 String
エラー
 ありません。

3.2.2.4.2.2. getEventMessage
名称 getEventMessage − イベントメッセージを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectedEvent {
    public String getEventMessage();
}
説明 このイベントのイベントメッセージを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.2.3. getBrokerAddress
名称 getBrokerAddress − コネクションの再接続先JMSサーバのアドレスを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectedEvent {
    public String getBrokerAddress();
}
説明 コネクションが再接続したJMSサーバのアドレスを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.2.4. getConnection
名称 getConnection − イベントと関連付けられているコネクションを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectedEvent {
    public javax.jms.Connection getConnection();
}
説明 このイベントに関連付けられているコネクションを取得します。
戻り値 javax.jms.Connection
エラー
 ありません。

3.2.2.4.2.5. CONNECTION_RECONNECTED
名称 CONNECTION_RECONNECTED − コネクションが再接続したことを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectedEvent {
    public static final String CONNECTION_RECONNECTED = "E301";
}
説明 ConnectionReconnectedEventのイベントコードです。 コネクションの自動再接続機能が有効になっている場合に、JMSサーバに再接続したことを示します。
関連項目
 com.nec.webotx.messaging.jms.notification.ConnectionReconnectedEvent#getEventCode()

3.2.2.4.3. ConnectionReconnectFailedEvent クラス
com.nec.webotx.messaging.jms.notification.ConnectionReconnectFailedEvent クラスは、コネクションの再接続失敗に関するイベントを表します。
getEventCode イベントコードを取得する
getEventMessage イベントメッセージを取得する
getBrokerAddress コネクションの再接続先JMSサーバのアドレスを取得する
getConnection イベントと関連付けられているコネクションを取得する
getJMSException コネクション再接続失敗の原因となったJMSExceptionを取得する
CONNECTION_RECONNECT_FAILED コネクションの再接続失敗を示す定数

3.2.2.4.3.1. getEventCode
名称 getEventCode − イベントコードを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectFailedEvent {
    public String getEventCode();
}
説明 このイベントのイベントコードを取得します。ConnectionReconnectFailedEventでは、次の値が返却されます。
ConnectionReconnectFailedEvent.CONNECTION_RECONNECT_FAILED
戻り値 String
エラー
 ありません。

3.2.2.4.3.2. getEventMessage
名称 getEventMessage − イベントメッセージを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectFailedEvent {
    public String getEventMessage();
}
説明 このイベントのイベントメッセージを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.3.3. getBrokerAddress
名称 getBrokerAddress − コネクションの再接続先JMSサーバのアドレスを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectFailedEvent {
    public String getBrokerAddress();
}
説明 コネクションが再接続を試みたJMSサーバのアドレスを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.3.4. getConnection
名称 getConnection − イベントを受信したコネクションを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectFailedEvent {
    public javax.jms.Connection getConnection();
}
説明 このイベントに関連付けられているコネクションを取得します。
戻り値 javax.jms.Connection
エラー
 ありません。

3.2.2.4.3.5. getJMSException
名称 getJMSException − コネクション再接続失敗の原因となったJMSExceptionを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectFailedEvent {
    public javax.jms.JMSException getJMSException();
}
説明 コネクションの再接続失敗の原因となったJMS例外を取得します。
戻り値 javax.jms.JMSException
エラー
 ありません。

3.2.2.4.3.6. CONNECTION_RECONNECT_FAILED
名称 CONNECTION_RECONNECT_FAILED − コネクションの再接続失敗を示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConnectionReconnectFailedEvent {
    public static final String CONNECTION_RECONNECT_FAILED = "E401";
}
説明 ConnectionClosedEventのイベントコードです。 コネクションの自動再接続機能が有効になっている場合に、JMSサーバへの再接続に失敗したことを示します。再接続に失敗するたびに通知を行います。 なお、例外リスナーは、再接続の試行回数が上限に達した場合のみに呼び出されます。
関連項目
 com.nec.webotx.messaging.jms.notification.ConnectionReconnectFailedEvent#getEventCode()

3.2.2.4.4. ConsumerEvent クラス
com.nec.webotx.messaging.jms.notification.ConsumerEvent クラスは、送信先に対するコンシューマの接続有無に関するイベントを表します。
getEventCode イベントコードを取得する
getEventMessage イベントメッセージを取得する
getBrokerAddress イベントを送信したJMSサーバのアドレスを取得する
getConnection イベントを受信したコネクションを取得する
getDestination イベントが発生した送信先を取得する
CONSUMER_NOT_READY コンシューマが存在しないことを示す定数
CONSUMER_READY コンシューマが存在することを示す定数

3.2.2.4.4.1. getEventCode
名称 getEventCode − イベントコードを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public String getEventCode();
}
説明 このイベントのイベントコードを取得します。ConsumerEventでは、次のいずれかの値が返却されます。
ConsumerEvent.CONSUMER_NOT_READY
ConsumerEvent.CONSUMER_READY
戻り値 String
エラー
 ありません。

3.2.2.4.4.2. getEventMessage
名称 getEventMessage − イベントメッセージを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public String getEventMessage();
}
説明 このイベントのイベントメッセージを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.4.3. getBrokerAddress
名称 getBrokerAddress − イベントを送信したJMSサーバのアドレスを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public String getBrokerAddress();
}
説明 このイベントを送信したJMSサーバのアドレスを取得します。
戻り値 String
エラー
 ありません。

3.2.2.4.4.4. getConnection
名称 getConnection − イベントを受信したコネクションを取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public javax.jms.Connection getConnection();
}
説明 このイベントを受信したコネクションを取得します。
戻り値 javax.jms.Connection
エラー
 ありません。

3.2.2.4.4.5. getDestination
名称 getDestination − イベントが発生した送信先を取得する
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public javax.jms.Destination getDestination();
}
説明 このイベントが発生した送信先を取得します。
戻り値 javax.jms.Destination
エラー
 ありません。

3.2.2.4.4.6. CONSUMER_NOT_READY
名称 CONSUMER_NOT_READY − コンシューマの準備ができていないことを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public static final String CONSUMER_NOT_READY = "E701";
}
説明 ConsumerEventのイベントコードです。 コンシューマの準備ができていない(コンシューマが存在している状態から存在しない状態になった)ことを示します。 なお、INACTIVE 状態の永続サブスクリプションは「存在しない」とみなされます。
関連項目
 com.nec.webotx.messaging.jms.notification.ConsumerEvent#getEventCode()

3.2.2.4.4.7. CONSUMER_READY
名称 CONSUMER_READY − コンシューマの準備ができたことを示す定数
形式 package com.nec.webotx.messaging.jmq.jmsclient;

public class ConsumerEvent {
    public static final String CONSUMER_READY = "E700";
}
説明 ConsumerEventのイベントコードです。 コンシューマの準備ができた(コンシューマが存在しない状態から存在する状態になった)ことを示します。 なお、INACTIVE 状態の永続サブスクリプションは「存在しない」とみなされます。
関連項目
 com.nec.webotx.messaging.jms.notification.ConsumerEvent#getEventCode()


3.2.3. C言語インタフェース

WebOTX JMSでは、以下のC言語インタフェースを提供しています。

3.2.3.1. BytesMessageインタフェース

3.2.3.2. Connectionインタフェース

3.2.3.3. ConnectionFactoryインタフェース

3.2.3.4. ConnectionMetaDataインタフェース

3.2.3.5. Enumerationインタフェース

3.2.3.6. Exceptionインタフェース

3.2.3.7. 共通インタフェース

3.2.3.8. MapMessageインタフェース

3.2.3.9. Messageインタフェース

3.2.3.10. MessageConsumerインタフェース

3.2.3.11. MessageProducerインタフェース

3.2.3.12. ObjectMessageインタフェース

3.2.3.13. Queueインタフェース

3.2.3.14. QueueBrowserインタフェース

3.2.3.15. Sessionインタフェース

3.2.3.16. StreamMessageインタフェース

3.2.3.17. TextMessageインタフェース

3.2.3.18. Topicインタフェース

3.2.3.19. TopicSubscriberインタフェース

3.2.3.1. BytesMessageインタフェース

BytesMessageインタフェースは、C言語ランタイムライブラリにてJMSのBytesMessageオブジェクトへのインタフェースを提供します。

BytesMessageインタフェースには次の関数があります。

JmsBytesMessageDestroy BytesMessageオブジェクトを破棄します。
JmsBytesMessageGetBodyLength BytesMessageオブジェクト内のストリームからメッセージの長さを取得します。
JmsBytesMessageReadBoolean BytesMessageオブジェクト内のストリームからboolean型のデータを読み取ります。
JmsBytesMessageReadByte BytesMessageオブジェクト内のストリームから符号付き8ビット値のデータを読み取ります。
JmsBytesMessageReadBytes BytesMessageオブジェクト内のストリームからバイト配列データを読み取ります。
JmsBytesMessageReadChar BytesMessageオブジェクト内のストリームからUnicode文字値を読み取ります。
JmsBytesMessageReadDouble BytesMessageオブジェクト内のストリームからdouble型のデータを読み取ります。
JmsBytesMessageReadFloat BytesMessageオブジェクト内のストリームからfloat型のデータを読み取ります。
JmsBytesMessageReadInt BytesMessageオブジェクト内のストリームから符号付き32ビット整数のデータを読み取ります。
JmsBytesMessageReadLong BytesMessageオブジェクト内のストリームから符号付き64ビット整数のデータを読み取ります。
JmsBytesMessageReadShort BytesMessageオブジェクト内のストリームから符号付き16ビット数のデータを読み取ります。
JmsBytesMessageReadUnsignedByte BytesMessageオブジェクト内のストリームから符号無し8ビット数のデータを読み取ります。
JmsBytesMessageReadUnsignedShort BytesMessageオブジェクト内のストリームから符号無し16ビット数のデータを読み取ります。
JmsBytesMessageReadUTF BytesMessageオブジェクト内のストリームからUTF-8形式を使用してエンコードされた文字列データを読み取ります。
JmsBytesMessageReset BytesMessageオブジェクトのメッセージ本文を読取り専用モードで配置してからストリームを先頭に再配置します。
JmsBytesMessageWriteBoolean BytesMessageオブジェクト内のストリームに、booleanを1バイト値として書き込みます。
JmsBytesMessageWriteByte BytesMessageオブジェクト内のストリームに、byteを1バイト値として書き込みます。
JmsBytesMessageWriteBytes BytesMessageオブジェクト内のストリームに、バイト配列を書き込みます。
JmsBytesMessageWriteChar BytesMessageオブジェクト内のストリームに、Unicode文字値を書き込みます。
JmsBytesMessageWriteDouble BytesMessageオブジェクト内のストリームに、doubleを8バイト値として書き込みます。
JmsBytesMessageWriteFloat BytesMessageオブジェクト内のストリームに、floatを4バイト値として書き込みます。
JmsBytesMessageWriteInt BytesMessageオブジェクト内のストリームに、intを4バイト値として書き込みます。
JmsBytesMessageWriteLong BytesMessageオブジェクト内のストリームに、longを8バイト値として書き込みます。
JmsBytesMessageWriteObject BytesMessageオブジェクト内のストリームに、Javaオブジェクトを書き込みます。
JmsBytesMessageWriteShort BytesMessageオブジェクト内のストリームに、shortを2バイト値として書き込みます。
JmsBytesMessageWriteUTF BytesMessageオブジェクト内のストリームに、文字列をUTF-8エンコーディング形式を使用して書き込みます。

 
3.2.3.1.1. JmsBytesMessageDestroy
名称 JmsBytesMessageDestroy - BytesMessageオブジェクトを破棄します。
形式 WOJMSStatus JmsBytesMessageDestroy( JmsBytesMessage *message );
説明 messageで指定したJmsBytesMessage構造体に指定されているBytesMessageオブジェクトを破棄します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.1.2. JmsBytesMessageGetBodyLength
名称 JmsBytesMessageGetBodyLength - BytesMessageオブジェクト内のストリームからメッセージの長さを取得します。
形式 WOJMSStatus JmsBytesMessageGetBodyLength( JmsBytesMessage *message, WOJMS_LONG *length );
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O length 取得したメッセージ長を格納するWOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.getBodyLength()
 
3.2.3.1.3. JmsBytesMessageReadBoolean
名称 JmsBytesMessageReadBoolean - BytesMessageオブジェクト内のストリームからboolean型のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadBoolean( JmsBytesMessage *message, WOJMS_BOOL *value );
説明 messageで指定したJmsBytesMessage構造体からbooleanを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったbooleanを格納するWOJMS_BOOLへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readBoolean()
 
3.2.3.1.4. JmsBytesMessageReadByte
名称 JmsBytesMessageReadByte - BytesMessageオブジェクト内のストリームから符号付き8ビット値のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadByte( JmsBytesMessage *message, WOJMS_BYTE *value );
説明 messageで指定したJmsBytesMessage構造体から8ビット値のデータを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取った8ビット値を格納するWOJMS_BYTESへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readByte()
 
3.2.3.1.5. JmsBytesMessageReadBytes
名称 JmsBytesMessageReadBytes - BytesMessageオブジェクト内のストリームからバイト配列データを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadBytes( JmsBytesMessage *message, WOJMS_BYTES *value, WOJMS_INT *length );
説明 messageで指定したJmsBytesMessage構造体からバイト配列データを読取り、引数valueに、読取ったデータ長を引数lengthに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったバイト配列を格納するWOJMS_BYTESへのポインタを指定します。
O length 読取ったバイト配列のデータ長を格納するWOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readBytes(byte[], int)
 
3.2.3.1.6. JmsBytesMessageReadChar
名称 JmsBytesMessageReadChar - BytesMessageオブジェクト内のストリームからUnicode文字値を読み取ります。
形式 WOJMSStatus JmsBytesMessageReadChar( JmsBytesMessage *message, WOJMS_CHAR *value );
説明 messageで指定したJmsBytesMessage構造体からUnicode文字列を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったUnicode文字列を格納するWOJMS_CHARへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readChar()
 
3.2.3.1.7. JmsBytesMessageReadDouble
名称 JmsBytesMessageReadDouble - BytesMessageオブジェクト内のストリームからdouble型のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadDouble( JmsBytesMessage *message, WOJMS_DOUBLE *value );
説明 messageで指定したJmsBytesMessage構造体からdoubleを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったdoubleを格納するWOJMS_DOUBLEへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readDouble()
 
3.2.3.1.8. JmsBytesMessageReadFloat
名称 JmsBytesMessageReadFloat - BytesMessageオブジェクト内のストリームからfloat型のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadFloat( JmsBytesMessage *message, WOJMS_FLOAT *value );
説明 messageで指定したJmsBytesMessage構造体からfloatを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったfloatを格納するWOJMS_FLOATへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readFloat()
 
3.2.3.1.9. JmsBytesMessageReadInt
名称 JmsBytesMessageReadInt - BytesMessageオブジェクト内のストリームから符号付き32ビット整数のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadInt( JmsBytesMessage *message, WOJMS_INT *value );
説明 messageで指定したJmsBytesMessage構造体からintを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったintを格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readInt()
 
3.2.3.1.10. JmsBytesMessageReadLong
名称 JmsBytesMessageReadLong - BytesMessageオブジェクト内のストリームから符号付き64ビット整数のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadLong( JmsBytesMessage *message, WOJMS_LONG *value );
説明 messageで指定したJmsBytesMessage構造体からlongを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったlongを格納するWOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readLong()
 
3.2.3.1.11. JmsBytesMessageReadShort
名称 JmsBytesMessageReadShort - BytesMessageオブジェクト内のストリームから符号付き16ビット数のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadShort( JmsBytesMessage *message, WOJMS_SHORT *value );
説明 messageで指定したJmsBytesMessage構造体からshortを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取ったshortを格納するWOJMS_SHORTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readShort()
 
3.2.3.1.12. JmsBytesMessageReadUnsignedByte
名称 JmsBytesMessageReadUnsignedByte - BytesMessageオブジェクト内のストリームから符号無し8ビット数のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadUnsignedByte( JmsBytesMessage *message, WOJMS_INT *value );
説明 messageで指定したJmsBytesMessage構造体から符号無し8ビット数のデータを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取った符号無し8ビット値を格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readUnsignedByte()
 
3.2.3.1.13. JmsBytesMessageReadUnsignedShort
名称 JmsBytesMessageReadUnsignedShort - BytesMessageオブジェクト内のストリームから符号無し16ビット数のデータを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadUnsignedShort( JmsBytesMessage *message, WOJMS_INT *value );
説明 messageで指定したJmsBytesMessage構造体から符号無し16ビット数のデータを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取った符号無し8ビット値を格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readUnsignedShort()
 
3.2.3.1.14. JmsBytesMessageReadUTF
名称 JmsBytesMessageReadUTF - BytesMessageオブジェクト内のストリームからUTF-8形式を使用してエンコードされた文字列データを読み取ります。
形式 WOJMSStatus JmsBytesMessageReadUTF( JmsBytesMessage *message, JmsString *value );
説明 messageで指定したJmsBytesMessage構造体からUTF-8形式でエンコードされたデータを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
O value 読取った符号無し8ビット値を格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.readUTF()
 
3.2.3.1.15. JmsBytesMessageReset
名称 JmsBytesMessageReset - BytesMessageオブジェクトのメッセージ本文を読取り専用モードで配置してからストリームを先頭に再配置します。
形式 WOJMSStatus JmsBytesMessageReset( JmsBytesMessage *message );
説明 messageで指定したJmsBytesMessage構造体を読取り専用モードにしてストリームを先頭に再配置します。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.reset()
 
3.2.3.1.16. JmsBytesMessageWriteBoolean
名称 JmsBytesMessageWriteBoolean - BytesMessageオブジェクト内のストリームに、booleanを1バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteBoolean( JmsBytesMessage *message, WOJMS_BOOL value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを1バイトのbooleanとして書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_BOOLの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeBoolean(boolean)
 
3.2.3.1.17. JmsBytesMessageWriteByte
名称 JmsBytesMessageWriteByte - BytesMessageオブジェクト内のストリームに、byteを1バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteByte( JmsBytesMessage *message, WOJMS_BYTE value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを1バイトのbyte値として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_BYTEの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeByte(byte)
 
3.2.3.1.18. JmsBytesMessageWriteBytes
名称 JmsBytesMessageWriteBytes - BytesMessageオブジェクト内のストリームに、バイト配列を書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteBytes( JmsBytesMessage *message, WOJMS_BYTES value, WOJMS_INT length );
説明 messageで指定したJmsBytesMessage構造体に、引数valueをバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_BYTEへのポインタを指定します。
I length 書き込みを行うWOJMS_BYTEの先頭からのバイト長を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeBytes(byte[], int, int)
 
3.2.3.1.19. JmsBytesMessageWriteChar
名称 JmsBytesMessageWriteChar - BytesMessageオブジェクト内のストリームに、Unicode文字値を書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteChar( JmsBytesMessage *message, WOJMS_CHAR value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueをUnicode文字として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_CHARの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeChar(char)
 
3.2.3.1.20. JmsBytesMessageWriteDouble
名称 JmsBytesMessageWriteDouble - BytesMessageオブジェクト内のストリームに、doubleを8バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteDouble( JmsBytesMessage *message, WOJMS_DOUBLE value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを8バイトdoubleのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_DOUBLEの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeDouble(double)
 
3.2.3.1.21. JmsBytesMessageWriteFloat
名称 JmsBytesMessageWriteFloat - BytesMessageオブジェクト内のストリームに、floatを4バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteFloat( JmsBytesMessage *message, WOJMS_FLOAT value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを4バイトfloatのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_FLOATの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeFloat(float)
 
3.2.3.1.22. JmsBytesMessageWriteInt
名称 JmsBytesMessageWriteInt - BytesMessageオブジェクト内のストリームに、intを4バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteInt( JmsBytesMessage *message, WOJMS_INT value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを4バイトint型のバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_INTの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeInt(int)
 
3.2.3.1.23. JmsBytesMessageWriteLong
名称 JmsBytesMessageWriteLong - BytesMessageオブジェクト内のストリームに、longを8バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteLong( JmsBytesMessage *message, WOJMS_LONG value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを8バイトlongのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_LONGの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeLong(long)
 
3.2.3.1.24. JmsBytesMessageWriteObject
名称 JmsBytesMessageWriteObject - BytesMessageオブジェクト内のストリームに、Javaオブジェクトを書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteObject( JmsBytesMessage *message, WOJMS_OBJECT value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueをJavaオブジェクトストリームのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_OBJECT構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeObject(java.lang.Object)
 
3.2.3.1.25. JmsBytesMessageWriteShort
名称 JmsBytesMessageWriteShort - BytesMessageオブジェクト内のストリームに、shortを2バイト値として書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteShort( JmsBytesMessage *message, WOJMS_SHORT value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを2バイトshortのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_SHORTの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeShort(short)
 
3.2.3.1.26. JmsBytesMessageWriteUTF
名称 JmsBytesMessageWriteUTF - BytesMessageオブジェクト内のストリームに、文字列をUTF-8エンコーディング形式を使用して書き込みます。
形式 WOJMSStatus JmsBytesMessageWriteUTF( JmsBytesMessage *message, JmsString *value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueをUTF-8形式でエンコードされた文字列のバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message BytesMessageオブジェクトを指すJmsBytesMessage構造体へのポインタを指定します。
I value 書き込みを行うJmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 BytesMessageオブジェクトが無効です。
関連項目 javax.jms.BytesMessage.writeUTF(java.lang.String)

3.2.3.2. Connectionインタフェース

Connectionインタフェースは、C言語ランタイムライブラリにてJMSのConnectionオブジェクトへのインタフェースを提供します。

Connectionインタフェースには次の関数があります。

JmsConnectionClose Connectionオブジェクトを閉じます
JmsConnectionCreateSession Sessionオブジェクトを生成します
JmsConnectionGetClientID ConnectionオブジェクトからクライアントIDを取得します
JmsConnectionGetExceptionListener ConnectionオブジェクトからExceptionListenerオブジェクトを取得します
JmsConnectionGetMetaData Connectionオブジェクトからメタデータを取得します
JmsConnectionSetClientID ConnectionオブジェクトにクライアントIDを設定します
JmsConnectionSetExceptionListener ConnectionオブジェクトにExceptionListenerを設定します
JmsConnectionStart Connectionオブジェクトを開始(または再開)します
JmsConnectionStop Connectionオブジェクトによる着信メッセージの配信を一時的に停止します
WOJmsConnectionCreateSession メッセージ再配信遅延時間を設定してSessionオブジェクトを生成します

 
3.2.3.2.1. JmsConnectionClose
名称 JmsConnectionClose - Connectionオブジェクトを閉じます
形式 WOJMSStatus JmsConnectionClose( JmsConnection *connection );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトをCLOSEします。プロバイダはJVM外部の重要なリソースを接続に代わって割り当てるため、 リソースが不要になった場合、クライアントがリソースを閉じる必要があります。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_OBJECT_NOT_AVTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.close()
 
3.2.3.2.2. JmsConnectionCreateSession
名称 JmsConnectionCreateSession - Sessionオブジェクトを生成します
形式 WOJMSStatus JmsConnectionCreateSession( JmsConnection *connection, JmsSession *session, WOJMS_BOOL transacted, WOJMS_INT acknowledgeMode );
説明 connectionで指定したConnectionオブジェクトのcreateSessionメソッドを、transacted、acknowledgeMode引数を指定して呼び出し、Sessionオブジェクトを生成します。生成したSessionオブジェクトは、sessionで指定したJmsSession構造体に設定して返却します。
引数 I/O パラメータ 説明
I connection createSessionメソッドを呼び出すConnectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
O session 生成したSessionオブジェクトを受け取るためのJmsSession構造体を指すポインタを指定します。
I transacted トランザクションセッションまたは、非トランザクションセッションを設定します。
WOJMS_TRUE：トランザクションセッションを生成します。
WOJMS_FALSE：非トランザクションセッションを生成します。
I acknowledgeMode Consumerのacknowledgeモードを指定します。 トランザクションセッションの場合はWOJMS_SESSION_TRANSACTED以外の値を指定しても無視されます。
WOJMS_AUTO_ACKNOWLEDGE：自動確認応答モード(再送要求不可)
WOJMS_CLIENT_ACKNOWLEDGE：インタフェース確認モード
WOJMS_DUPS_OK_ACKNOWLEDGE：自動確認応答モード
WOJMS_NO_ACKNOWLEDGE：確認応答なしモード
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_AVTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.createSession(boolean, int)
 
3.2.3.2.3. JmsConnectionGetClientID
名称 JmsConnectionGetClientID - ConnectionオブジェクトからクライアントIDを取得します。
形式 WOJMSStatus JmsConnectionGetClientID( JmsConnection *connection, JmsString *clientID );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトからクライアントIDを取得し、引数clientIDに格納します。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
O clientID 取得したクライアントIDを格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.getClientID()
 
3.2.3.2.4. JmsConnectionGetExceptionListener
名称 JmsConnectionGetExceptionListener - ConnectionオブジェクトからExceptionListenerオブジェクトを取得します。
形式 WOJMSStatus JmsConnectionGetExceptionListener( JmsConnection *connection, JmsExceptionListenerFunc *exceptionListener) );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトからExceptionListenerオブジェクトを取得し、引数exceptionListenerに格納します。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
O exceptionListener 取得したExceptionListenerオブジェクトを格納するJmsExceptionListenerFunc構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
関連項目 javax.jms.Connection.getExceptionListener()
 
3.2.3.2.5. JmsConnectionGetMetaData
名称 JmsConnectionGetMetaData - Connectionオブジェクトからメタデータを取得します。
形式 WOJMSStatus JmsConnectionGetMetaData( JmsConnection *connection, JmsMetaData *data );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトからメタデータを取得し、引数dataに格納します。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
O data 取得したメタデータを格納するJmsMetaData構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.getMetaData()
 
3.2.3.2.6. JmsConnectionSetClientID
名称 JmsConnectionSetClientID - ConnectionオブジェクトにクライアントIDを設定します。
形式 WOJMSStatus JmsConnectionSetClientID( JmsConnection *connection, JmsString *clientID );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトに、引数clientIDで指定した、クライアントIDを設定します。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
I clientID Connectionオブジェクトに設定する、クライアントIDを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.setClientID(java.lang.String)
 
3.2.3.2.7. JmsConnectionSetExceptionListener
名称 JmsConnectionSetExceptionListener - ConnectionオブジェクトにExceptionListenerを設定します。
形式 WOJMSStatus JmsConnectionSetExceptionListener( JmsConnection *connection, JmsExceptionListenerFunc *exceptionListener );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトに引数exceptionListenerで指定した、ExceptionListenerオブジェクトを設定します。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
I exceptionListener Connectionオブジェクトで例外が発生した際にコールバックされる、JmsExceptionListenerFunc型の関数ポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.setExceptionListener(ExceptionListener)
 
3.2.3.2.8. JmsConnectionStart
名称 JmsConnectionStart - Connectionオブジェクトを開始(または再開)します
形式 WOJMSStatus JmsConnectionStart( JmsConnection *connection );
説明 connectionで指定されたJmsConnection構造体に指定されているConnectionオブジェクトを開始します。なお、開始済みの接続に対するJmsConnectionStartの呼び出しは無視されます。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_OBJECT_NOT_AVTIVE_ERROR -7 Connectionオブジェクトが無効です
関連項目 javax.jms.Connection.start()
 
3.2.3.2.9. JmsConnectionStop
名称 JmsConnectionStop - Connectionオブジェクトによる着信メッセージの配信を一時的に停止します。
形式 WOJMSStatus JmsConnectionStop( JmsConnection *connection );
説明 connectionで指定したJmsConnection構造体に指定されているConnectionオブジェクトによる着信メッセージの配信を一時的に停止します。
引数 I/O パラメータ 説明
I connection Connectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 javax.jms.Connection.stop()
 
3.2.3.2.10. WOJmsConnectionCreateSession
名称 WOJmsConnectionCreateSession - メッセージ再配信遅延時間を設定してSessionオブジェクトを生成します
形式 WOJMSStatus WOJmsConnectionCreateSession( JmsConnection *connection, JmsSession *session, WOJMS_BOOL transacted, WOJMS_INT acknowledgeMode, WOJMS_INT redelaytime );
説明 connectionで指定したConnectionオブジェクトのcreateSessionメソッドを、transacted、acknowledgeMode、redeliverytime引数を指定して呼び出し、Sessionオブジェクトを生成します。生成したSessionオブジェクトは、sessionで指定したJmsSession構造体に設定して返却します。
この関数で生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると、実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。
引数 I/O パラメータ 説明
I connection createSessionメソッドを呼び出すConnectionオブジェクトを指すJmsConnection構造体へのポインタを指定します。
O session 生成したSessionオブジェクトを受け取るためのJmsSession構造体を指すポインタを指定します。
I transacted トランザクションセッションまたは、非トランザクションセッションを設定します。
WOJMS_TRUE：トランザクションセッションを生成します。
WOJMS_FALSE：非トランザクションセッションを生成します。
I acknowledgeMode Consumerのacknowledgeモードを指定します。 トランザクションセッションの場合はWOJMS_SESSION_TRANSACTED以外の値を指定しても無視されます。
WOJMS_AUTO_ACKNOWLEDGE：自動確認応答モード(再送要求不可)
WOJMS_CLIENT_ACKNOWLEDGE：インタフェース確認モード
WOJMS_DUPS_OK_ACKNOWLEDGE：自動確認応答モード
WOJMS_NO_ACKNOWLEDGE：確認応答なしモード
I redelaytime メッセージ再配信遅延時間を相対時間(秒)で指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Connectionオブジェクトが無効です。
関連項目 -

3.2.3.3. ConnectionFactoryインタフェース

ConnectionFactoryインタフェースは、C言語ランタイムライブラリにてJMSのConnectionFactoryオブジェクトへのインタフェースを提供します。

ConnectionFactoryインタフェースには次の関数があります。

JmsConnectionFactoryCreateConnection Connectionオブジェクトを生成します
JmsConnectionFactoryDestroy ConnectionFactoryオブジェクトを破棄します

 
3.2.3.3.1. JmsConnectionFactoryCreateConnection
名称 JmsConnectionFactoryCreateConnection - Connectionオブジェクトを生成します
形式 WOJMSStatus JmsConnectionFactoryCreateConnection( JmsConnectionFactory *factory, JmsConnection *connection, char *userName, char *password );
説明 factoryで指定したConnectionFactoryオブジェクトのcreateConnectionメソッドを、userName、password引数を指定して呼び出し、Connectionオブジェクトを生成します。生成したConnectionオブジェクトは、connectionで指定したJmsConnection構造体に設定して返却します。
引数 I/O パラメータ 説明
I factory createConnectionメソッドを呼び出すConnectionFactoryオブジェクトを指すJmsConnectionFactory構造体へのポインタを指定します。
O connection 生成したConnectionオブジェクトを受け取るためのJmsConnection構造体を指すポインタを指定します。
I userName 呼び出し側のユーザ名を指定します。createConnectionメソッド呼び出し時にJMSサーバ認証をおこなう場合に、設定されたユーザIDをNULL終端文字列で指定します。NULLを指定した場合は、ユーザ情報を指定しないcreateConnection,メソッドを呼び出します。
I password 呼び出し側のパスワードを指定します。createConnectionメソッド呼び出し時にJMSサーバ認証をおこなう場合に、設定されたユーザ名のパスワードをNULL終端文字列で指定します。NULLを指定した場合は、ユーザ情報を指定しないcreateConnectionメソッドを呼び出します
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionFactoryオブジェクトが無効です。
関連項目 javax.jms.ConnectionFactory.createConnection(java.lang.String, java.lang.String)
 
3.2.3.3.2. JmsConnectionFactoryDestroy
名称 JmsConnectionFactoryDestroy - ConnectionFactoryオブジェクトを破棄します
形式 WOJMSStatus JmsConnectionFactoryDestroy( JmsConnectionFactory *factory );
説明 factoryで指定されたJmsConnectionFactory構造体に指定されているConnectionFactoryオブジェクトを破棄します。
引数 I/O パラメータ 説明
I factory ConnectionFactoryオブジェクトを指すJmsConnectionFactory構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -

3.2.3.4. ConnectionMetaDataインタフェース

ConnectionMetaDataインタフェースは、C言語ランタイムライブラリにてConnectionMetaDataオブジェクトへのインタフェースを提供します。

ConnectionMetaDataインタフェースには次の関数があります。

JmsMetaDataDestroy ConnectionMetaDataオブジェクトを破棄します
JmsMetaDataGetJMSMajorVersion JMSのメジャーバージョン番号を取得します
JmsMetaDataGetJMSMinorVersion JMSのマイナーバージョン番号を取得します
JmsMetaDataGetJMSProviderName JMS プロバイダ名を取得します
JmsMetaDataGetJMSVersion JMS API のバージョンを取得します
JmsMetaDataGetJMSXPropertyName JMSX プロパティ名の列挙を取得します
JmsMetaDataGetProviderMajorVersion JMS プロバイダのメジャーバージョン番号を取得します
JmsMetaDataGetProviderMinorVersion JMS プロバイダのマイナーバージョン番号を取得します
JmsMetaDataGetProviderVersion JMS プロバイダのバージョンを取得します

 
3.2.3.4.1. JmsMetaDataDestroy
名称 JmsMetaDataDestroy - ConnectionMetaDataオブジェクトを破棄します
形式 WOJMSStatus JmsMetaDataDestroy( JmsMetaData *metaData );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトを破棄します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.4.2. JmsMetaDataGetJMSMajorVersion
名称 JmsMetaDataGetJMSMajorVersion - JMSのメジャーバージョン番号を取得します
形式 WOJMSStatus JmsMetaDataGetJMSMajorVersion( JmsMetaData *metaData, WOJMS_INT *jmsMajor );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMSメジャーバージョン番号を取得し、引数jmsMajorに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O jmsMajor 取得したJMSメジャーバージョン番号を格納する、WOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getJMSMajorVersion()
 
3.2.3.4.3. JmsMetaDataGetJMSMinorVersion
名称 JmsMetaDataGetJMSMinorVersion - JMSのマイナーバージョン番号を取得します
形式 WOJMSStatus JmsMetaDataGetJMSMinorVersion( JmsMetaData *metaData, WOJMS_INT *jmsMinor );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMSマイナーバージョン番号を取得し、引数jmsMinorに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O jmsMinor 取得したJMSマイナーバージョン番号を格納する、WOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getJMSMinorVersion()
 
3.2.3.4.4. JmsMetaDataGetJMSProviderName
名称 JmsMetaDataGetJMSProviderName - JMS プロバイダ名を取得します
形式 WOJMSStatus JmsMetaDataGetJMSProviderName( JmsMetaData *metaData, JmsString *providerName );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMSプロバイダ名を取得し、引数providerNameに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O providerName 取得したJMSプロバイダ名を格納する、JmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getJMSProviderName()
 
3.2.3.4.5. JmsMetaDataGetJMSVersion
名称 JmsMetaDataGetJMSVersion - JMS API のバージョンを取得します
形式 WOJMSStatus JmsMetaDataGetJMSVersion( JmsMetaData *metaData, JmsString *jmsVersion );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMS APIのバージョンを取得し、引数jmsVersionに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O jmsVersion 取得したJMS APIバージョン情報を格納する、JmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getJMSVersion()
 
3.2.3.4.6. JmsMetaDataGetJMSXPropertyName
名称 JmsMetaDataGetJMSXPropertyName - JMSX プロパティ名の列挙を取得します
形式 WOJMSStatus JmsMetaDataGetJMSXPropertyName( JmsMetaData *metaData, JmsEnumeration *props );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMSXプロパティ名のリストを取得し、引数propsに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O props 取得したJMSXのプロパティ名リストを格納する、JmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getJMSXPropertyNames()
 
3.2.3.4.7. JmsMetaDataGetProviderMajorVersion
名称 JmsMetaDataGetProviderMajorVersion - JMS プロバイダのメジャーバージョン番号を取得します
形式 WOJMSStatus JmsMetaDataGetProviderMajorVersion( JmsMetaData *metaData, WOJMS_INT *providerMajor );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMS プロバイダのメジャーバージョン番号を取得し、引数providerMajorに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O providerMajor 取得したJMS プロバイダのメジャーバージョンを格納する、WOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getProviderMajorVersion()
 
3.2.3.4.8. JmsMetaDataGetProviderMinorVersion
名称 JmsMetaDataGetProviderMinorVersion - JMS プロバイダのマイナーバージョン番号を取得します
形式 WOJMSStatus JmsMetaDataGetProviderMinorVersion( JmsMetaData *metaData, WOJMS_INT *providerMinor );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMS プロバイダのマイナーバージョン番号を取得し、引数providerMinorに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O providerMinor 取得したJMS プロバイダのマイナーバージョンを格納する、WOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getProviderMinorVersion()
 
3.2.3.4.9. JmsMetaDataGetProviderVersion
名称 JmsMetaDataGetProviderVersion - JMS プロバイダのバージョンを取得します
形式 WOJMSStatus JmsMetaDataGetProviderVersion( JmsMetaData *metaData, JmsString *providerVersion );
説明 metaDataに指定したJmsMetaDataに指定されているConnectionMetaDataオブジェクトからJMS プロバイダのバージョン情報を取得し、引数providerVersionに格納します。
引数 I/O パラメータ 説明
I metaData ConnectionMetaDataオブジェクトを指す、JmsMetaData構造体へのポインタを指定します。
O providerVersion 取得したJMS プロバイダのメジャーバージョンを格納する、JmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionMetaDataオブジェクトが無効です。
関連項目 javax.jms.ConnectionMetaData.getProviderVersion()

3.2.3.5. Enumerationインタフェース

Enumerationインタフェースは、C言語ランタイムライブラリにてJava Enumerationオブジェクトへのインタフェースを提供します。

Enumerationインタフェースには次の関数があります。

JmsEnumerationDestroy Enumerationオブジェクトを破棄します
JmsEnumerationHasMoreElement 列挙にさらに要素があるかどうかを判定します
JmsEnumerationNextElementForMessage 次のJMSメッセージ要素を取得します
JmsEnumerationNextElementForString 次の文字列要素を取得します

 
3.2.3.5.1. JmsEnumerationDestroy
名称 JmsEnumerationDestroy - Enumerationオブジェクトを破棄します
形式 WOJMSStatus JmsEnumerationDestroy( JmsEnumeration *enumeration );
説明 enumerationに指定したJmsEnumeration構造体に指定されているEnumerationオブジェクトを破棄します。
引数 I/O パラメータ 説明
I enumeration 対象のEnumerationオブジェクトを指すJmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.5.2. JmsEnumerationHasMoreElement
名称 JmsEnumerationHasMoreElement - 列挙にさらに要素があるかどうかを判定します
形式 WOJMS_BOOL JmsEnumerationHasMoreElement( JmsEnumeration *enumeration );
説明 enumerationに指定したJmsEnumeration構造体に指定されているEnumerationオブジェクト内に次の要素があるかどうかを判定し、結果を返却します。
引数 I/O パラメータ 説明
I enumeration hasMoreElementsメソッドを呼び出す、Enumerationオブジェクトを指すJmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_TRUE 1 次の要素が存在します。
WOJMS_FALSE 0 次の要素は存在しません。
関連項目 java.util.Enumeration.hasMoreElements()
 
3.2.3.5.3. JmsEnumerationNextElementForMessage
名称 JmsEnumerationNextElementForMessage - 次のJMSメッセージ要素を取得します
形式 WOJMSStatus JmsEnumerationNextElementForMessage( JmsEnumeration *enumeration, JmsMessage *element );
説明 enumerationに指定したJmsEnumeration構造体に指定されているEnumerationオブジェクト内から次のJMSメッセージ要素を取得し、引数elementに格納します。
引数 I/O パラメータ 説明
I enumeration nextElementメソッドを呼び出す、Enumerationオブジェクトを指すJmsEnumeration構造体へのポインタを指定します。
O element 取得したJMSメッセージオブジェクトを格納する、JmsMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Enumerationオブジェクトが無効です。
関連項目 java.util.Enumeration.nextElement()
 
3.2.3.5.4. JmsEnumerationNextElementForString
名称 JmsEnumerationNextElementForString - 次の文字列要素を取得します
形式 WOJMSStatus JmsEnumerationNextElementForMessage( JmsEnumeration *enumeration, JmsString *element );
説明 enumerationに指定したJmsEnumeration構造体に指定されているEnumerationオブジェクト内から次の文字列要素を取得し、引数elementに格納します。
引数 I/O パラメータ 説明
I enumeration nextElementメソッドを呼び出す、Enumerationオブジェクトを指すJmsEnumeration構造体へのポインタを指定します。
O element 取得した文字列を格納する、JmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Enumerationオブジェクトが無効です。
関連項目 java.util.Enumeration.nextElement()

3.2.3.6. Exceptionインタフェース

Exceptionインタフェースは、C言語ランタイムライブラリにてJMSException例外オブジェクトへのインタフェースを提供します。

Exceptionインタフェースには次の関数があります。

JmsExceptionGetCauseException Exceptionオブジェクトの原因または null (原因が存在しないか未知の場合) を返します。
JmsExceptionGetErrorCode Exceptionオブジェクトの原因を示す、ベンダ固有のエラーコードを返します。
JmsExceptionGetLinkedException Exceptionオブジェクトにリンクされた例外オブジェクトを返します。
JmsExceptionGetMessage Exceptionオブジェクトの詳細メッセージ文字列を返します。
JmsExceptionGetStack Exceptionオブジェクトからスタックトレース情報を返します。
JmsExceptionIsJmsException ExceptionオブジェクトがJMSExceptionオブジェクトであるかどうかを返します。
JmsExceptionPrintStack Exceptionブジェクトおよびそのバックトレースを標準エラーストリームに出力します。

 
3.2.3.6.1. JmsExceptionGetCauseException
名称 JmsExceptionGetCauseException - Exceptionオブジェクトの原因または null (原因が存在しないか未知の場合) を返します。
形式 WOJMSStatus JmsExceptionGetCauseException( JmsException *exception, JmsException *causeException );
説明 exceptionで指定したJmsException構造体に指定されているJMSExceptionオブジェクトから、例外の元となるExceptionオブジェクトを取得し、引数causeExceptionに格納します。
引数 I/O パラメータ 説明
I exception 対象のExceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
O causeException 取得したExceptionオブジェクトを格納する、JmsException構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Exceptionオブジェクトが無効です。
関連項目 -
 
3.2.3.6.2. JmsExceptionGetErrorCode
名称 JmsExceptionGetErrorCode - Exceptionオブジェクトの原因を示す、ベンダ固有のエラーコードを返します。
形式 WOJMSStatus JmsExceptionGetErrorCode( JmsException *exception, JmsString *code );
説明 exceptionで指定したJmsException構造体に指定されているExceptionオブジェクトから、JMS実装を行っているベンダ固有のエラーコード文字列を取得し、引数codeに格納します。
引数 I/O パラメータ 説明
I exception Exceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
O code 取得したエラーコードを格納する、JmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Exceptionオブジェクトが無効です。
WOJMS_NOT_JMS_EXCEPTION_ERROR -10 JMSExceptionオブジェクトではありません。
関連項目 javax.jms.JMSException.getErrorCode()
 
3.2.3.6.3. JmsExceptionGetLinkedException
名称 JmsExceptionGetLinkedException - Exceptionオブジェクトにリンクされた例外オブジェクトを返します。
形式 WOJMSStatus JmsExceptionGetLinkedException( JmsException *exception, JmsException *linkedExcp );
説明 exceptionで指定したJmsException構造体に指定されているExceptionオブジェクトからリンクされた例外オブジェクトを取得し、引数linkedExcpに格納します。
引数 I/O パラメータ 説明
I exception 対象のExceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
O linkedExcp 取得した例外オブジェクトを格納する、JmsException構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Exceptionオブジェクトが無効です。
WOJMS_NOT_JMS_EXCEPTION_ERROR -10 JMSExceptionオブジェクトではありません。
関連項目 javax.jms.JMSException.getLinkedException()
 
3.2.3.6.4. JmsExceptionGetMessage
名称 JmsExceptionGetMessage - Exceptionオブジェクトの詳細メッセージ文字列を返します。
形式 WOJMSStatus JmsExceptionGetMessage( JmsException *exception, JmsString *message );
説明 exceptionで指定したJmsException構造体に指定されているExceptionオブジェクトから例外の原因を示す詳細メッセージを取得し、引数messageに格納します。
引数 I/O パラメータ 説明
I exception Exceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
O message 取得したメッセージを格納する、JmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Exceptionオブジェクトが無効です。
関連項目 -
 
3.2.3.6.5. JmsExceptionGetStack
名称 JmsExceptionGetStack - Exceptionオブジェクトからスタックトレース情報を返します。
形式 WOJMSStatus JmsExceptionGetStack( JmsException *exception, JmsString *stack );
説明 exceptionで指定したJmsException構造体に指定されているExceptionオブジェクトからスタックトレース情報を取得し、引数stackに格納します。
引数 I/O パラメータ 説明
I exception Exceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
O stack 取得したスタックトレース情報を格納する、JmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Exceptionオブジェクトが無効です。
関連項目 -
 
3.2.3.6.6. JmsExceptionIsJmsException
名称 JmsExceptionIsJmsException - ExceptionオブジェクトがJMSExceptionオブジェクトであるかどうかを返します。
形式 WOJMS_BOOL JmsExceptionIsJmsException( JmsException *exception );
説明 exceptionで指定したJmsException構造体に指定されているExceptionオブジェクトが、JMSExceptionオブジェクトであるかどうかを調査し、結果をWOJMS_BOOL値で返却します。
引数 I/O パラメータ 説明
I exception Exceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
戻り値 WOJMS_TRUE 1 このExceptionはJMSExceptionです。
WOJMS_FALSE 0 このExceptionはJMSExceptionではありません。
関連項目 -
 
3.2.3.6.7. JmsExceptionPrintStack
名称 JmsExceptionPrintStack - Exceptionブジェクトおよびそのバックトレースを標準エラーストリームに出力します。
形式 WOJMSStatus JmsExceptionPrintStack( JmsException *exception );
説明 exceptionで指定したJmsException構造体に指定されているExceptionオブジェクトおよびそのバックトレースを標準エラーストリームに出力します。
引数 I/O パラメータ 説明
I exception Exceptionオブジェクトを指す、JmsException構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Exceptionオブジェクトが無効です。
関連項目 -

3.2.3.7. 共通インタフェース

共通インタフェースは、C言語ランタイムライブラリの初期化や停止のインタフェースを提供します。

共通インタフェースには次の関数があります。

JmsCommonCreateConnectionFactory ConnectionFactoryオブジェクトを生成します
JmsCommonDestroyString JmsStringのバッファ領域を解放します
JmsCommonGetConnectionFactory ConnectionFactoryオブジェクトを取得します
JmsCommonGetException Exceptionオブジェクトを取得します
JmsCommonGetQueue Queueオブジェクトを取得します
JmsCommonGetTopic Topicオブジェクトを取得します
JmsCommonReleaseException Exceptionオブジェクトを解放します
JmsServiceInit JavaVMを生成します
JmsServiceTerm JavaVMを削除します

 
3.2.3.7.1. JmsCommonCreateConnectionFactory
名称 JmsCommonCreateConnectionFactory - ConnectionFactoryオブジェクトを生成します
形式 WOJMSStatus JmsCommonCreateConnectionFactory( JmsConnectionFactory *factory, char *host, int port );
説明 host、port引数を指定してConnectionFactoryオブジェクトを生成します。生成したConnectionFactoryオブジェクトは、factoryで指定したJmsConnectionFactory構造体に設定して返却します。
引数 I/O パラメータ 説明
O factory 生成したConnectionFactoryオブジェクトを受け取るためのJmsConnectionFactory構造体を指すポインタを指定します。
I host ホスト名を設定します。NULLを指定した場合、既定値（localhost）に対して接続します。
I port ポート番号を設定します。0を指定した場合、既定値（9700）に対して接続します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.7.2. JmsCommonDestroyString
名称 JmsCommonDestroyString - JmsStringのバッファ領域を解放します
形式 WOJMSStatus JmsCommonDestroyString( JmsString *value );
説明 valueで指定されたJmsStringのバッファ領域を解放します。
引数 I/O パラメータ 説明
I value JmsString構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
関連項目 -
 
3.2.3.7.3. JmsCommonGetConnectionFactory
名称 JmsCommonGetConnectionFactory - ConnectionFactoryオブジェクトを取得します
形式 WOJMSStatus JmsCommonGetConnectionFactory( JmsConnectionFactory *factory, char *name, JndiInfo *info );
説明 name、info引数を指定してJNDIサーバからJMSリソースをlookupし、factoryで指定されたJmsConnectionFactory構造体にConnectionFactoryオブジェクトを設定して返却します。
引数 I/O パラメータ 説明
O factory ConnectionFactoryオブジェクトを受け取るためのJmsConnectionFactory構造体を指すポインタを指定します。
I name ConnectionFactoryのJNDI登録名を文字列で指定します。
I info JNDIの環境変数が設定されているJndiInfo構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.7.4. JmsCommonGetException
名称 JmsCommonGetException - Exceptionオブジェクトを取得します
形式 WOJMSStatus JmsCommonGetException( JmsException *exception );
説明 各関数にてエラーが発生した場合、詳細なエラー内容を取得する場合に使用します。
引数 I/O パラメータ 説明
O exception 関数実行時にスローされたExceptionオブジェクトを受け取るためのJmsException構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
関連項目 -
 
3.2.3.7.5. JmsCommonGetQueue
名称 JmsCommonGetQueue - Queueオブジェクトを取得します
形式 WOJMSStatus JmsCommonGetQueue( JmsQueue *queue, char *name, JndiInfo *info );
説明 name、info引数を指定してJNDIサーバからJMSリソースをlookupし、queueで指定されたJmsQueue構造体にQueueオブジェクトを設定して返却します。
引数 I/O パラメータ 説明
O queue Queueオブジェクトを受け取るためのJmsQueue構造体を指すポインタを指定します。
I name QueueのJNDI登録名を文字列で指定します。
I info JNDIの環境変数が設定されているJndiInfo構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.7.6. JmsCommonGetTopic
名称 JmsCommonGetTopic - Topicオブジェクトを取得します
形式 WOJMSStatus JmsCommonGetTopic( JmsTopic *topic, char *name, JndiInfo *info );
説明 name、info引数を指定してJNDIサーバからJMSリソースをlookupし、topicで指定されたJmsTopic構造体にTopicオブジェクトを設定して返却します。
引数 I/O パラメータ 説明
O topic Topicオブジェクトを受け取るためのJmsTopic構造体を指すポインタを指定します。
I name TopicのJNDI登録名を文字列で指定します。
I info JNDIの環境変数が設定されているJndiInfo構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.7.7. JmsCommonReleaseException
名称 JmsCommonReleaseException - Exceptionオブジェクトを解放します
形式 WOJMSStatus JmsCommonReleaseException( JmsException *exception );
説明 exceptionで指定されたJmsException構造体に指定されているExceptionオブジェクトを解放します。
引数 I/O パラメータ 説明
I exception Exceptionオブジェクトを指すJmsException構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.7.8. JmsServiceInit
名称 JmsServiceInit - JavaVMを生成します
形式 WOJMSStatus JmsServiceInit( char *config, int flags );
説明 flagsにWOJMS_NEW_JVMを指定して呼び出された場合は、JMSライブラリでJavaVMを新規生成します。この時configで構成ファイルへのパスを指定した場合は、指定した構成ファイルから読み込んだJavaVM起動プロパティを指定してJavaVMを起動します。configでNULLが指定された場合は、全プロセス共通の構成ファイルから読み込んだJavaVM起動プロパティを指定して起動します。
flagsにWOJMS_USED_JVMを指定して呼び出された場合は、既に生成されたJavaVMの取得を試みます。生成されたJavaVMが存在しない場合は、WOJMS_NEW_JVMが指定された場合と同様の動作が行われます。複数のJavaVMが生成されている場合は、最初に生成されたJavaVMを使用します。
なお、本関数はAPのメインスレッドから呼び出す必要があります。
引数 I/O パラメータ 説明
I config プロセス単位のJavaVM起動プロパティを設定した構成ファイルをフルパスで指定します。 NULLを指定した場合は、共通のプロパティを指定してJavaVMを起動します。
I flags JavaVMを新規生成するか生成済みのJavaVMを取得するかを指定します。 APでJNIを利用する場合、APでJavaVMを生成済みで、同一のJavaVMを利用する場合は、WOJMS_USED_JVMを指定することで生成済みのJavaVMを取得して使用します。
WOJMS_NEW_JVM：新規生成します。
WOJMS_USED_JVM：JavaVMの取得を試みます。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_FILE_NOT_FOUND_ERROR -3 指定された構成ファイルのオープンに失敗しました。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.7.9. JmsServiceTerm
名称 JmsServiceTerm - JavaVMを削除します
形式 WOJMSStatus JmsServiceTerm( void );
説明 生成したJavaVMを削除します。なお、JmsServiceInit関数実行時にJavaVMを生成した場合のみ削除処理を行います。JmsServiceInit関数にてJavaVMが生成されていない場合は、何もしないで、正常終了します。
引数 なし。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_JVM_ERROR -4 JavaVMの削除に失敗しました。
関連項目 -

3.2.3.8. MapMessageインタフェース

MapMessageインタフェースは、C言語ランタイムライブラリにてJMSのMapMessageオブジェクトへのインタフェースを提供します。

MapMessageインタフェースには次の関数があります。

JmsMapMessageDestroy MapMessageオブジェクトを破棄します。
JmsMapMessageGetBoolean MapMessageオブジェクト内のストリームからメッセージの長さを取得します。
JmsMapMessageGetByte MapMessageオブジェクトから指定された名前を保持するbyte値を返します。
JmsMapMessageGetBytes MapMessageオブジェクトから指定された名前を保持するバイト配列値を返します。
JmsMapMessageGetChar MapMessageオブジェクトから指定された名前を保持するUnicode文字の値を返します。
JmsMapMessageGetDouble MapMessageオブジェクトから指定された名前を保持するdouble値を返します。
JmsMapMessageGetFloat MapMessageオブジェクトから指定された名前を保持するfloat値を返します。
JmsMapMessageGetInt MapMessageオブジェクトから指定された名前を保持するint値を返します。
JmsMapMessageGetLong MapMessageオブジェクトから指定された名前を保持するlong値を返します。
JmsMapMessageGetMapNames MapMessageオブジェクトに保持されているデータ名のリストを返します。
JmsMapMessageGetObject MapMessageオブジェクトから指定された名前を保持するJavaオブジェクトを返します。
JmsMapMessageGetShort MapMessageオブジェクトから指定された名前を保持するshort値を返します。
JmsMapMessageGetString MapMessageオブジェクトから指定された名前を保持する文字列の値を返します。
JmsMapMessageItemExists MapMessageオブジェクトに指定された名前の項目が存在するかどうかを返します。
JmsMapMessageSetBoolean MapMessageオブジェクトに指定された名前を保持するboolean値を設定します。
JmsMapMessageSetByte MapMessageオブジェクトに指定された名前を保持するbyte値を設定します。
JmsMapMessageSetBytes MapMessageオブジェクトに指定された名前を保持するバイト配列値を設定します。
JmsMapMessageSetChar MapMessageオブジェクトに指定された名前を保持するUnicode文字値を設定します。
JmsMapMessageSetDouble MapMessageオブジェクトに指定された名前を保持するdouble値を設定します。
JmsMapMessageSetFloat MapMessageオブジェクトに指定された名前を保持するfloat値を設定します。
JmsMapMessageSetInt MapMessageオブジェクトに指定された名前を保持するint値を設定します。
JmsMapMessageSetLong MapMessageオブジェクトに指定された名前を保持するlong値を設定します。
JmsMapMessageSetObject MapMessageオブジェクトに指定された名前を保持するjavaオブジェクトを設定します。
JmsMapMessageSetShort MapMessageオブジェクトに指定された名前を保持するshort値を設定します。
JmsMapMessageSetString MapMessageオブジェクトに指定された名前を保持する文字列の値を設定します。

 
3.2.3.8.1. JmsMapMessageDestroy
名称 JmsMapMessageDestroy - MapMessageオブジェクトを破棄します。
形式 WOJMSStatus JmsMapMessageDestroy( JmsMapMessage *message );
説明 messageで指定したJmsMapMessage構造体に指定されているMapMessageオブジェクトを破棄します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.8.2. JmsMapMessageGetBoolean
名称 JmsMapMessageGetBoolean - MapMessageオブジェクト内のストリームからメッセージの長さを取得します。
形式 WOJMSStatus JmsMapMessageGetBoolean( JmsMapMessage *message, WOJMS_BOOL *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するboolean値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったbooleanを格納するWOJMS_BOOLへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getBoolean(java.lang.String)
 
3.2.3.8.3. JmsMapMessageGetByte
名称 JmsMapMessageGetByte - MapMessageオブジェクトから指定された名前を保持するbyte値を返します。
形式 WOJMSStatus JmsMapMessageGetByte( JmsMapMessage *message, WOJMS_BYTE *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するbyte値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったbyteを格納するWOJMS_BYTEへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getByte(java.lang.String)
 
3.2.3.8.4. JmsMapMessageGetBytes
名称 JmsMapMessageGetBytes - MapMessageオブジェクトから指定された名前を保持するバイト配列値を返します。
形式 WOJMSStatus JmsMapMessageGetBytes( JmsMapMessage *message, WOJMS_BYTES *value, WOJMS_INT *length, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するbyte配列値を読取り引数valueに、読取ったbyte配列長を引数lengthに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったbyte配列を格納するWOJMS_BYTESへのポインタを指定します。
O length 読取ったbyte配列長を格納するWOJMS_INTへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getBytes(java.lang.String)
 
3.2.3.8.5. JmsMapMessageGetChar
名称 JmsMapMessageGetChar - MapMessageオブジェクトから指定された名前を保持するUnicode文字の値を返します。
形式 WOJMSStatus JmsMapMessageGetChar( JmsMapMessage *message, WOJMS_CHAR *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するUnicode値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったUnicode値を格納するWOJMS_CHARへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getChar(java.lang.String)
 
3.2.3.8.6. JmsMapMessageGetDouble
名称 JmsMapMessageGetDouble - MapMessageオブジェクトから指定された名前を保持するdouble値を返します。
形式 WOJMSStatus JmsMapMessageGetDouble( JmsMapMessage *message, WOJMS_DOUBLE *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するdouble値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったdouble値を格納するWOJMS_DOUBLEへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getDouble(java.lang.String)
 
3.2.3.8.7. JmsMapMessageGetFloat
名称 JmsMapMessageGetFloat - MapMessageオブジェクトから指定された名前を保持するfloat値を返します。
形式 WOJMSStatus JmsMapMessageGetFloat( JmsMapMessage *message, WOJMS_FLOAT *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するfloat値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったfloat値を格納するWOJMS_FLOATへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getFloat(java.lang.String)
 
3.2.3.8.8. JmsMapMessageGetInt
名称 JmsMapMessageGetInt - MapMessageオブジェクトから指定された名前を保持するint値を返します。
形式 WOJMSStatus JmsMapMessageGetInt( JmsMapMessage *message, WOJMS_INT *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するint値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったint値を格納するWOJMS_INTへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getInt(java.lang.String)
 
3.2.3.8.9. JmsMapMessageGetLong
名称 JmsMapMessageGetLong - MapMessageオブジェクトから指定された名前を保持するlong値を返します。
形式 WOJMSStatus JmsMapMessageGetLong( JmsMapMessage *message, WOJMS_LONG *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するlong値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったlong値を格納するWOJMS_LONGへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getLong(java.lang.String)
 
3.2.3.8.10. JmsMapMessageGetMapNames
名称 JmsMapMessageGetMapNames - MapMessageオブジェクトに保持されているデータ名のリストを返します。
形式 WOJMSStatus JmsMapMessageGetMapNames( JmsMapMessage *message, JmsEnumeration *value );
説明 messageで指定したJmsMapMessage構造体から、メッセージオブジェクト内のすべての名前リストを取得し、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 取得した名前リストを格納する、JmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getMapNames()
 
3.2.3.8.11. JmsMapMessageGetObject
名称 JmsMapMessageGetObject - MapMessageオブジェクトから指定された名前を保持するJavaオブジェクトを返します。
形式 WOJMSStatus JmsMapMessageGetObject( JmsMapMessage *message, WOJMS_OBJECT *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するjavaオブジェクトを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったjavaオブジェクトをを格納するWOJMS_OBJECTへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getObject(java.lang.String)
 
3.2.3.8.12. JmsMapMessageGetShort
名称 JmsMapMessageGetShort - MapMessageオブジェクトから指定された名前を保持するshort値を返します。
形式 WOJMSStatus JmsMapMessageGetShort( JmsMapMessage *message, WOJMS_SHORT *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持するshort値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取ったshort値を格納するWOJMS_SHORTへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getShort(java.lang.String)
 
3.2.3.8.13. JmsMapMessageGetString
名称 JmsMapMessageGetString - MapMessageオブジェクトから指定された名前を保持する文字列の値を返します。
形式 WOJMSStatus JmsMapMessageGetString( JmsMapMessage *message, JmsString *value, JmsString *name );
説明 messageで指定したJmsMapMessage構造体から、引数nameの名前を保持する文字列の値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O value 読取った文字列を格納するJmsStringへのポインタを指定します。
I name MapMessageオブジェクトから、読取るデータの項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.getString(java.lang.String)
 
3.2.3.8.14. JmsMapMessageItemExists
名称 JmsMapMessageItemExists - MapMessageオブジェクトに指定された名前の項目が存在するかどうかを返します。
形式 WOJMSStatus JmsMapMessageItemExists( JmsMapMessage *message, WOJMS_BOOL *result, JmsString *name );
説明 messageで指定したJmsMapMessage構造体に引数nameで指定した名前項目が存在するかどうかを取得し、結果を引数resultに格納します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
O result 取得した結果を格納するWOJMS_BOOLへのポインタを指定します。
I name MapMessageオブジェクトから、存在の確認を行う項目名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.itemExists(java.lang.String)
 
3.2.3.8.15. JmsMapMessageSetBoolean
名称 JmsMapMessageSetBoolean - MapMessageオブジェクトに指定された名前を保持するboolean値を設定します。
形式 WOJMSStatus JmsMapMessageSetBoolean( JmsMapMessage *message, JmsString *name, WOJMS_BOOL value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したboolean値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_BOOLの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setBoolean(java.lang.String, boolean)
 
3.2.3.8.16. JmsMapMessageSetByte
名称 JmsMapMessageSetByte - MapMessageオブジェクトに指定された名前を保持するbyte値を設定します。
形式 WOJMSStatus JmsMapMessageSetByte( JmsMapMessage *message, JmsString *name, WOJMS_BYTE value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したbyte値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_BYTEの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setByte(java.lang.String, byte)
 
3.2.3.8.17. JmsMapMessageSetBytes
名称 JmsMapMessageSetBytes - MapMessageオブジェクトに指定された名前を保持するバイト配列値を設定します。
形式 WOJMSStatus JmsMapMessageSetBytes( JmsMapMessage *message, JmsString *name, WOJMS_BYTES value, WOJMS_INT length );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したバイト配列値の先頭から引数lengthの長さ分設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_BYTESへのポインタを指定します。
I length MapMessageオブジェクトにMap登録するバイト配列値の長さを指定します
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setBytes(java.lang.String, byte[], int, int)
 
3.2.3.8.18. JmsMapMessageSetChar
名称 JmsMapMessageSetChar - MapMessageオブジェクトに指定された名前を保持するUnicode文字値を設定します。
形式 WOJMSStatus JmsMapMessageSetChar( JmsMapMessage *message, JmsString *name, WOJMS_CHAR value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したUnicode文字の値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_CHARの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setChar(java.lang.String, char)
 
3.2.3.8.19. JmsMapMessageSetDouble
名称 JmsMapMessageSetDouble - MapMessageオブジェクトに指定された名前を保持するdouble値を設定します。
形式 WOJMSStatus JmsMapMessageSetDouble( JmsMapMessage *message, JmsString *name, WOJMS_DOUBLE value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したdouble値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_DOUBLEの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setDouble(java.lang.String, double)
 
3.2.3.8.20. JmsMapMessageSetFloat
名称 JmsMapMessageSetFloat - MapMessageオブジェクトに指定された名前を保持するfloat値を設定します。
形式 WOJMSStatus JmsMapMessageSetFloat( JmsMapMessage *message, JmsString *name, WOJMS_FLOAT value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したfloat値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_FLOATの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setFloat(java.lang.String, float)
 
3.2.3.8.21. JmsMapMessageSetInt
名称 JmsMapMessageSetInt - MapMessageオブジェクトに指定された名前を保持するint値を設定します。
形式 WOJMSStatus JmsMapMessageSetInt( JmsMapMessage *message, JmsString *name, WOJMS_INT value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したint値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_INTの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setInt(java.lang.String, int)
 
3.2.3.8.22. JmsMapMessageSetLong
名称 JmsMapMessageSetLong - MapMessageオブジェクトに指定された名前を保持するlong値を設定します。
形式 WOJMSStatus JmsMapMessageSetLong( JmsMapMessage *message, JmsString *name, WOJMS_LONG value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したlong値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_LONGの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setLong(java.lang.String, long)
 
3.2.3.8.23. JmsMapMessageSetObject
名称 JmsMapMessageSetObject - MapMessageオブジェクトに指定された名前を保持するjavaオブジェクトを設定します。
形式 WOJMSStatus JmsMapMessageSetObject( JmsMapMessage *message, JmsString *name, WOJMS_OBJECT value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したjavaオブジェクトを設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録すWOJMS_OBJECTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setObject(java.lang.String, java.lang.Object)
 
3.2.3.8.24. JmsMapMessageSetShort
名称 JmsMapMessageSetShort - MapMessageオブジェクトに指定された名前を保持するshort値を設定します。
形式 WOJMSStatus JmsMapMessageSetShort( JmsMapMessage *message, JmsString *name, WOJMS_SHORT value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定したshort値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するWOJMS_SHORTの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setShort(java.lang.String, short)
 
3.2.3.8.25. JmsMapMessageSetString
名称 JmsMapMessageSetString - MapMessageオブジェクトに指定された名前を保持する文字列の値を設定します。
形式 WOJMSStatus JmsMapMessageSetString( JmsMapMessage *message, JmsString *name, JmsString *value );
説明 messageで指定したJmsMapMessage構造体に、引数nameの名前を保持する、引数valueで指定した文字列の値を設定します。
引数 I/O パラメータ 説明
I message MapMessageオブジェクトを指すJmsMapMessage構造体へのポインタを指定します。
I name MapMessageオブジェクトにMap登録するデータの項目名を指定します。
I value MapMessageオブジェクトにMap登録するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MapMessageオブジェクトが無効です。
関連項目 javax.jms.MapMessage.setString(java.lang.String, String)

3.2.3.9. Messageインタフェース

Messageインタフェースは、C言語ランタイムライブラリにてJMSのMessageオブジェクトへのインタフェースを提供します。

Messageインタフェースには次の関数があります。

JmsMessageAcknowledge メッセージを確認応答します
JmsMessageClearBody Messageオブジェクトの本文をクリアします。
JmsMessageClearProperties Messageオブジェクトのプロパティをクリアします。
JmsMessageDestroy Messageオブジェクトを破棄します
JmsMessageGetBooleanProperty 指定された名前を保持するboolean型のプロパティを返します。
JmsMessageGetByteProperty 指定された名前を保持するbyte型のプロパティを返します。
JmsMessageGetDoubleProperty 指定された名前を保持するdouble型のプロパティを返します。
JmsMessageGetFloatProperty 指定された名前を保持するfloat型のプロパティを返します。
JmsMessageGetIntProperty 指定された名前を保持するint型のプロパティを返します。
JmsMessageGetJMSCorrelationID Messageオブジェクトの相関IDを取得します。
JmsMessageGetJMSCorrelationIDAsBytes Messageオブジェクトの相関IDをバイト配列として取得します。
JmsMessageGetJMSDeliveryMode このMessageオブジェクト用に指定された配信モード値を取得します。
JmsMessageGetJMSDestination このMessageオブジェクト用の送信先オブジェクトを取得します。
JmsMessageGetJMSExpiration Messageオブジェクトの有効期限値を取得します。
JmsMessageGetJMSMessageID MessageオブジェクトのメッセージIDを取得します。
JmsMessageGetJMSPriority Messageオブジェクトの優先度を取得します。
JmsMessageGetJMSRedelivered このMessageオブジェクトが再配信中であるかどうかを示す指示を取得します。
JmsMessageGetJMSReplyTo このMessageオブジェクトへの応答の送信先である 送信先オブジェクトを取得します。
JmsMessageGetJMSTimestamp Messageオブジェクトのタイムスタンプを取得します。
JmsMessageGetJMSType Messageオブジェクトの送信時にクライアントにより指定されたメッセージ型識別子を取得します。
JmsMessageGetLongProperty 指定された名前を保持するlong型のプロパティを返します。
JmsMessageGetObjectProperty 指定された名前を保持するJavaオブジェクト型のプロパティを返します。
JmsMessageGetPropertyNames すべてのプロパティ名の一覧を返します。
JmsMessageGetShortProperty 指定された名前を保持するshort型のプロパティを返します。
JmsMessageGetStringProperty 指定された名前を保持する文字列型のプロパティを返します。
JmsMessagePropertyExists Messageオブジェクトのプロパティ値が存在するかどうかを示します。
JmsMessageSetBooleanProperty Messageオブジェクト内に、指定された名前を保持するboolean型のプロパティ値を設定します。
JmsMessageSetByteProperty Messageオブジェクト内に、指定された名前を保持するbyte型のプロパティ値を設定します。
JmsMessageSetDoubleProperty Messageオブジェクト内に、指定された名前を保持するdouble型のプロパティ値を設定します。
JmsMessageSetFloatProperty Messageオブジェクト内に、指定された名前を保持するfloat型のプロパティ値を設定します。
JmsMessageSetIntProperty Messageオブジェクト内に、指定された名前を保持するint型のプロパティ値を設定します。
JmsMessageSetJMSCorrelationID Messageオブジェクトの相関IDを設定します。
JmsMessageSetJMSCorrelationIDAsBytes Messageオブジェクトの相関IDをバイト配列として設定します。
JmsMessageSetJMSDeliveryMode Messageオブジェクトに配信モード値を設定します。
JmsMessageSetJMSDestination Messageオブジェクトに送信先オブジェクトを設定します。
JmsMessageSetJMSExpiration Messageオブジェクトの有効期限値を設定します。
JmsMessageSetJMSMessageID MessageオブジェクトのメッセージIDを設定します。
JmsMessageSetJMSPriority Messageオブジェクトの優先度を設定します。
JmsMessageSetJMSRedelivered Messageオブジェクトが再配信中であるかどうかを指定します。
JmsMessageSetJMSReplyTo Messageオブジェクトへの応答の送信先である 送信先オブジェクトを設定します。
JmsMessageSetJMSTimestamp Messageオブジェクトのタイムスタンプを設定します。
JmsMessageSetJMSType Messageオブジェクトにメッセージ型識別子を設定します。
JmsMessageSetLongProperty Messageオブジェクト内に、指定された名前を保持するlong型のプロパティ値を設定します。
JmsMessageSetObjectProperty Messageオブジェクト内に、指定された名前を保持するJavaオブジェクト型のプロパティ値を設定します。
JmsMessageSetShortProperty Messageオブジェクト内に、指定された名前を保持するshort型のプロパティ値を設定します。
JmsMessageSetStringProperty Messageオブジェクト内に、指定された名前を保持する文字列型のプロパティ値を設定します。

 
3.2.3.9.1. JmsMessageAcknowledge
名称 JmsMessageAcknowledge - メッセージを確認応答します
形式 WOJMSStatus JmsMessageAcknowledge( JmsMessage *message );
説明 messageで指定したMessageオブジェクトのacknowledgeメソッドを呼び出し、メッセージを確認応答します。 処理済みのメッセージに対してJmsMessageAcknowledgeを呼び出すことにより、クライアントは、メッセージ配信先のセッションにより処理されたすべてのメッセージを確認応答できます。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.acknowledge()
 
3.2.3.9.2. JmsMessageClearBody
名称 JmsMessageClearBody - Messageオブジェクトの本文をクリアします。
形式 WOJMSStatus JmsMessageClearBody( JmsMessage *message );
説明 messageで指定したMessageオブジェクトのclearBodyメソッドを呼び出し、メッセージ本文をクリアします。メッセージ内のヘッダ値やプロパティのエントリはクリアされません。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.clearBody()
 
3.2.3.9.3. JmsMessageClearProperties
名称 JmsMessageClearProperties - Messageオブジェクトのプロパティをクリアします。
形式 WOJMSStatus JmsMessageClearProperties( JmsMessage *message );
説明 messageで指定したMessageオブジェクトのclearPropertiesメソッドを呼び出し、メッセージ本文をクリアします。メッセージ内のヘッダ値やプロパティのエントリはクリアされません。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.clearProperties()
 
3.2.3.9.4. JmsMessageDestroy
名称 JmsMessageDestroy - Messageオブジェクトを破棄します
形式 WOJMSStatus JmsMessageDestroy( JmsMessage *message );
説明 messageで指定したJmsMessage構造体に指定されているMessageオブジェクトを破棄します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.9.5. JmsMessageGetBooleanProperty
名称 JmsMessageGetBooleanProperty - 指定された名前を保持するboolean型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetBooleanProperty( JmsMessage *message, WOJMS_BOOL *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するboolean型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_BOOLへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getBooleanProperty(java.lang.String)
 
3.2.3.9.6. JmsMessageGetByteProperty
名称 JmsMessageGetByteProperty - 指定された名前を保持するbyte型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetByteProperty( JmsMessage *message, WOJMS_BYTE *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するbyte型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_BYTEへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.getByteProperty(java.lang.String)
 
3.2.3.9.7. JmsMessageGetDoubleProperty
名称 JmsMessageGetDoubleProperty - 指定された名前を保持するdouble型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetDoubleProperty( JmsMessage *message, WOJMS_DOUBLE *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するdouble型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_DOUBLEへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getDoubleProperty(java.lang.String)
 
3.2.3.9.8. JmsMessageGetFloatProperty
名称 JmsMessageGetFloatProperty - 指定された名前を保持するfloat型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetFloatProperty( JmsMessage *message, WOJMS_FLOAT *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するfloat型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_FLOATへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getFloatProperty(java.lang.String)
 
3.2.3.9.9. JmsMessageGetIntProperty
名称 JmsMessageGetIntProperty - 指定された名前を保持するint型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetIntProperty( JmsMessage *message, WOJMS_INT *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するint型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_INTへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getIntProperty(java.lang.String)
 
3.2.3.9.10. JmsMessageGetJMSCorrelationID
名称 JmsMessageGetJMSCorrelationID - Messageオブジェクトの相関IDを取得します。
形式 WOJMSStatus JmsMessageGetJMSCorrelationID( JmsMessage *message, JmsString *correlationID );
説明 messageで指定したJmsMessage構造体から相関IDを取得し、引数correlationIDに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O correlationID 取得した相関IDを格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSCorrelationID()
 
3.2.3.9.11. JmsMessageGetJMSCorrelationIDAsBytes
名称 JmsMessageGetJMSCorrelationIDAsBytes - Messageオブジェクトの相関IDをバイト配列として取得します。
形式 WOJMSStatus JmsMessageGetJMSCorrelationIDAsBytes( JmsMessage *message, WOJMS_BYTES *correlationID, WOJMS_INT *length );
説明 messageで指定したJmsMessage構造体から相関IDをバイト配列として取得し、引数correlationIDに、取得したバイト配列長をlengthに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O correlationID 取得した相関IDを格納するWOJMS_BYTESへのポインタを指定します。
O length 取得したバイト配列長を格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSCorrelationIDAsBytes()
 
3.2.3.9.12. JmsMessageGetJMSDeliveryMode
名称 JmsMessageGetJMSDeliveryMode - このMessageオブジェクト用に指定された配信モード値を取得します。
形式 WOJMSStatus JmsMessageGetJMSDeliveryMode( JmsMessage *message, WOJMS_INT *deliveryMode );
説明 messageで指定したJmsMessage構造体から配信モードを取得し、引数deliveryModeに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O deliveryMode 取得した配信モードを格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSDeliveryMode()
 
3.2.3.9.13. JmsMessageGetJMSDestination
名称 JmsMessageGetJMSDestination - このMessageオブジェクト用の送信先オブジェクトを取得します。
形式 WOJMSStatus JmsMessageGetJMSDestination( JmsMessage *message, JmsDestination *destination );
説明 messageで指定したJmsMessage構造体から送信先オブジェクトを取得し、引数destinationに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O destination 取得した送信先を格納するJmsDestination構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSDestination()
 
3.2.3.9.14. JmsMessageGetJMSExpiration
名称 JmsMessageGetJMSExpiration - Messageオブジェクトの有効期限値を取得します。
形式 WOJMSStatus JmsMessageGetJMSExpiration( JmsMessage *message, WOJMS_LONG *expiration );
説明 messageで指定したJmsMessage構造体からメッセージの有効期限を取得し、引数expirationに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O expiration 取得したメッセージの有効期限を格納するWOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSExpiration()
 
3.2.3.9.15. JmsMessageGetJMSMessageID
名称 JmsMessageGetJMSMessageID - MessageオブジェクトのメッセージIDを取得します。
形式 WOJMSStatus JmsMessageGetJMSMessageID( JmsMessage *message, JmsString *messageID );
説明 messageで指定したJmsMessage構造体からメッセージIDを取得し、引数messageIDに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O messageID 取得したメッセージIDを格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSMessageID()
 
3.2.3.9.16. JmsMessageGetJMSPriority
名称 JmsMessageGetJMSPriority - Messageオブジェクトの優先度を取得します。
形式 WOJMSStatus JmsMessageGetJMSPriority( JmsMessage *message, WOJMS_INT *priority );
説明 messageで指定したJmsMessage構造体から優先度を取得し、引数priorityに格納します。
取得する優先度は、もっとも低い優先度が 0 で、もっとも高い優先度が 9 です。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O priority 取得した優先度を格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSPriority()
 
3.2.3.9.17. JmsMessageGetJMSRedelivered
名称 JmsMessageGetJMSRedelivered - このMessageオブジェクトが再配信中であるかどうかを示す指示を取得します。
形式 WOJMSStatus JmsMessageGetJMSRedelivered( JmsMessage *message, WOJMS_BOOL *redelivered );
説明 messageで指定したJmsMessage構造体が再配信中であるかどうかを取得し、引数redeliveredに格納します。
クライアントが再配信中のメッセージを受信した場合、このメッセージは以前に配信されて、受信が確認応答されなかった可能性が高いことを示します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O redelivered 取得した再配信中指示を格納するWOJMS_BOOLへのポインタを指定します。
WOJMS_TRUE: このメッセージは再配信中です。
WOJMS_FALSE: このメッセージは再配信中ではありません。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSRedelivered()
 
3.2.3.9.18. JmsMessageGetJMSReplyTo
名称 JmsMessageGetJMSReplyTo - このMessageオブジェクトへの応答の送信先である 送信先オブジェクトを取得します。
形式 WOJMSStatus JmsMessageGetJMSReplyTo( JmsMessage *message, JmsDestination *destination );
説明 messageで指定したJmsMessage構造体への対応の送信先オブジェクトを取得し、引数destinationに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O destination 取得した送信先オブジェクトを受け取るためのJmsDestination構造体を示すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSReplyTo()
 
3.2.3.9.19. JmsMessageGetJMSTimestamp
名称 JmsMessageGetJMSTimestamp - Messageオブジェクトのタイムスタンプを取得します。
形式 WOJMSStatus JmsMessageGetJMSTimestamp( JmsMessage *message, WOJMS_LONG *timestamp );
説明 messageで指定したJmsMessage構造体からタイムスタンプを取得し、引数timestampに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O timestamp 取得した配信モードを格納するWOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSTimestamp()
 
3.2.3.9.20. JmsMessageGetJMSType
名称 JmsMessageGetJMSType - Messageオブジェクトの送信時にクライアントにより指定されたメッセージ型識別子を取得します。
形式 WOJMSStatus JmsMessageGetJMSType( JmsMessage *message, JmsString *type );
説明 messageで指定したJmsMessage構造体からメッセージ型識別子を取得し、引数typeに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O type 取得したメッセージ型識別子を格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getJMSType()
 
3.2.3.9.21. JmsMessageGetLongProperty
名称 JmsMessageGetLongProperty - 指定された名前を保持するlong型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetLongProperty( JmsMessage *message, WOJMS_LONG *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するlong型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_LONGへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getLongProperty(java.lang.String)
 
3.2.3.9.22. JmsMessageGetObjectProperty
名称 JmsMessageGetObjectProperty - 指定された名前を保持するJavaオブジェクト型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetObjectProperty( JmsMessage *message, WOJMS_OBJECT *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するJavaオブジェクト型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_OBJECTへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getObjectProperty(java.lang.String)
 
3.2.3.9.23. JmsMessageGetPropertyNames
名称 JmsMessageGetPropertyNames - すべてのプロパティ名の一覧を返します。
形式 WOJMSStatus JmsMessageGetPropertyNames( JmsMessage *message, JmsEnumeration *value );
説明 messageで指定したJmsMessage構造体に指定されている、プロパティ名の一覧を取得し、引数valueに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ名一覧を格納するJmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getPropertyNames()
 
3.2.3.9.24. JmsMessageGetShortProperty
名称 JmsMessageGetShortProperty - 指定された名前を保持するshort型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetShortProperty( JmsMessage *message, WOJMS_SHORT *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するshort型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するWOJMS_SHORTへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getShortProperty(java.lang.String)
 
3.2.3.9.25. JmsMessageGetStringProperty
名称 JmsMessageGetStringProperty - 指定された名前を保持する文字列型のプロパティを返します。
形式 WOJMSStatus JmsMessageGetStringProperty( JmsMessage *message, JmsString *value, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持する文字列型のプロパティ値を返します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O value 取得したプロパティ値を格納するJmsStringへのポインタを指定します。
I name 取得対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.getStringProperty(java.lang.String)
 
3.2.3.9.26. JmsMessagePropertyExists
名称 JmsMessagePropertyExists - Messageオブジェクトのプロパティ値が存在するかどうかを示します。
形式 WOJMSStatus JmsMessagePropertyExists( JmsMessage *message, WOJMS_BOOL *result, JmsString *name );
説明 messageで指定したJmsMessage構造体に指定されている、引数nameの名前を保持するプロパティ値が存在するかどうかを取得し、引数resultに格納します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
O result 取得した確認結果を格納するWOJMS_BOOLへのポインタを指定します。
I name 存在確認を行う対象のプロパティ名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.propertyExists(java.lang.String)
 
3.2.3.9.27. JmsMessageSetBooleanProperty
名称 JmsMessageSetBooleanProperty - Messageオブジェクト内に、指定された名前を保持するboolean型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetBooleanProperty( JmsMessage *message, JmsString *name, WOJMS_BOOL value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setBooleanProperty(java.lang.String, boolean)
 
3.2.3.9.28. JmsMessageSetByteProperty
名称 JmsMessageSetByteProperty - Messageオブジェクト内に、指定された名前を保持するbyte型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetByteProperty( JmsMessage *message, JmsString *name, WOJMS_BYTE value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setByteProperty(java.lang.String, byte)
 
3.2.3.9.29. JmsMessageSetDoubleProperty
名称 JmsMessageSetDoubleProperty - Messageオブジェクト内に、指定された名前を保持するdouble型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetDoubleProperty( JmsMessage *message, JmsString *name, WOJMS_DOUBLE value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setDoubleProperty(java.lang.String, double)
 
3.2.3.9.30. JmsMessageSetFloatProperty
名称 JmsMessageSetFloatProperty - Messageオブジェクト内に、指定された名前を保持するfloat型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetFloatProperty( JmsMessage *message, JmsString *name, WOJMS_FLOAT value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setFloatProperty(java.lang.String, float)
 
3.2.3.9.31. JmsMessageSetIntProperty
名称 JmsMessageSetIntProperty - Messageオブジェクト内に、指定された名前を保持するint型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetIntProperty( JmsMessage *message, JmsString *name, WOJMS_INT value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setIntProperty(java.lang.String, int)
 
3.2.3.9.32. JmsMessageSetJMSCorrelationID
名称 JmsMessageSetJMSCorrelationID - Messageオブジェクトの相関IDを文字列で設定します。
形式 WOJMSStatus JmsMessageSetJMSCorrelationID( JmsMessage *message, JmsString *correlationID );
説明 messageで指定したJmsMessage構造体に、引数correlationIDの相関IDを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I correlationID 設定する相関IDを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSCorrelationID(java.lang.String)
 
3.2.3.9.33. JmsMessageSetJMSCorrelationIDAsBytes
名称 JmsMessageSetJMSCorrelationIDAsBytes - Messageオブジェクトの相関IDをバイト配列として設定します。
形式 WOJMSStatus JmsMessageSetJMSCorrelationIDAsBytes( JmsMessage *message, WOJMS_BYTES correlationID, WOJMS_INT length );
説明 messageで指定したJmsMessage構造体に、引数correlationIDの相関IDをバイト配列で設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I correlationID 設定する相関IDバイト配列を指定します。
I length 読取るバイト配列長を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSCorrelationIDAsBytes(byte[])
 
3.2.3.9.34. JmsMessageSetJMSDeliveryMode
名称 JmsMessageSetJMSDeliveryMode - Messageオブジェクトに配信モード値を設定します。
形式 WOJMSStatus JmsMessageSetJMSDeliveryMode( JmsMessage *message, WOJMS_INT deliveryMode );
説明 messageで指定したJmsMessage構造体に、引数deliveryModeの配信モードを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I deliveryMode 設定する配信モードを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSDeliveryMode(int)
 
3.2.3.9.35. JmsMessageSetJMSDestination
名称 JmsMessageSetJMSDestination - Messageオブジェクトに送信先オブジェクトを設定します。
形式 WOJMSStatus JmsMessageSetJMSDestination( JmsMessage *message, JmsDestination *destination );
説明 messageで指定したJmsMessage構造体に、引数destinationで指定した送信先オブジェクトを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I destination 送信先オブジェクトを指すJmsDestination構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSDestination(javax.jms.Destination)
 
3.2.3.9.36. JmsMessageSetJMSExpiration
名称 JmsMessageSetJMSExpiration - Messageオブジェクトの有効期限値を設定します。
形式 WOJMSStatus JmsMessageSetJMSExpiration( JmsMessage *message, WOJMS_LONG expiration );
説明 messageで指定したJmsMessage構造体に、引数expirationで指定したメッセージオブジェクトの有効期限値を設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I expiration 設定する有効期限値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSExpiration(long)
 
3.2.3.9.37. JmsMessageSetJMSMessageID
名称 JmsMessageSetJMSMessageID - MessageオブジェクトのメッセージIDを設定します。
形式 WOJMSStatus JmsMessageSetJMSMessageID( JmsMessage *message, JmsString *messageID );
説明 messageで指定したJmsMessage構造体に、messageIDで指定したメッセージIDを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I messageID 設定するメッセージIDを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSMessageID(java.lang.String)
 
3.2.3.9.38. JmsMessageSetJMSPriority
名称 JmsMessageSetJMSPriority - Messageオブジェクトの優先度を設定します。
形式 WOJMSStatus JmsMessageSetJMSPriority( JmsMessage *message, WOJMS_INT priority );
説明 messageで指定したJmsMessage構造体に、引数priorityで指定したメッセージオブジェクトの優先度を設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I priority 設定する優先度を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSPriority(int)
 
3.2.3.9.39. JmsMessageSetJMSRedelivered
名称 JmsMessageSetJMSRedelivered - Messageオブジェクトが再配信中であるかどうかを指定します。
形式 WOJMSStatus JmsMessageSetJMSRedelivered( JmsMessage *message, WOJMS_BOOL redelivered );
説明 messageで指定したJmsMessage構造体に、引数redeliveredで指定した再配信中かどうかを示す値を設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I redelivered このメッセージが再配信中であるかどうかを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSRedelivered(boolean)
 
3.2.3.9.40. JmsMessageSetJMSReplyTo
名称 JmsMessageSetJMSReplyTo - Messageオブジェクトへの応答の送信先である 送信先オブジェクトを設定します。
形式 WOJMSStatus JmsMessageSetJMSReplyTo( JmsMessage *message, JmsDestination *destination );
説明 messageで指定したJmsMessage構造体に、引数destinationで指定した送信先オブジェクトを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I destination 送信先オブジェクトを指すJmsDestination構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSReplyTo(javax.jms.Destination)
 
3.2.3.9.41. JmsMessageSetJMSTimestamp
名称 JmsMessageSetJMSTimestamp - Messageオブジェクトのタイムスタンプを設定します。
形式 WOJMSStatus JmsMessageSetJMSTimestamp( JmsMessage *message, WOJMS_LONG timestamp );
説明 messageで指定したJmsMessage構造体に、引数timestampで指定したタイムスタンプを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I timestamp 設定するタイムスタンプを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSTimestamp(long)
 
3.2.3.9.42. JmsMessageSetJMSType
名称 JmsMessageSetJMSType - Messageオブジェクトにメッセージ型識別子を設定します。
形式 WOJMSStatus JmsMessageSetJMSType( JmsMessage *message, JmsString *type );
説明 messageで指定したJmsMessage構造体に、引数typeで指定したメッセージ型識別子を設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I type 設定するメッセージ型識別子を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setJMSType(java.lang.String)
 
3.2.3.9.43. JmsMessageSetLongProperty
名称 JmsMessageSetLongProperty - Messageオブジェクト内に、指定された名前を保持するlong型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetLongProperty( JmsMessage *message, JmsString *name, WOJMS_LONG value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setLongProperty(java.lang.String, long)
 
3.2.3.9.44. JmsMessageSetObjectProperty
名称 JmsMessageSetObjectProperty - Messageオブジェクト内に、指定された名前を保持するJavaオブジェクト型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetObjectProperty( JmsMessage *message, JmsString *name, WOJMS_OBJECT value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setObjectProperty(java.lang,String, java.lang.Object)
 
3.2.3.9.45. JmsMessageSetShortProperty
名称 JmsMessageSetShortProperty - Messageオブジェクト内に、指定された名前を保持するshort型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetShortProperty( JmsMessage *message, JmsString *name, WOJMS_SHORT value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setShortProperty(java.lang.String, short)
 
3.2.3.9.46. JmsMessageSetStringProperty
名称 JmsMessageSetStringProperty - Messageオブジェクト内に、指定された名前を保持する文字列型のプロパティ値を設定します。
形式 WOJMSStatus JmsMessageSetStringProperty( JmsMessage *message, JmsString *name, JmsString *value );
説明 messageで指定したJmsMessage構造体に、引数nameの名前と、引数valueの値を持つプロパティを設定します。
引数 I/O パラメータ 説明
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I name 設定するプロパティ名を指定します。
I value 設定するプロパティ値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Messageオブジェクトが無効です。
関連項目 javax.jms.Message.setStringProperty(java.lang.String, java.lang.String)

3.2.3.10. MessageConsumerインタフェース

MessageConsumerインタフェースは、C言語ランタイムライブラリにてJMSのMessageConsumerオブジェクトへのインタフェースを提供します。

MessageConsumerインタフェースには次の関数があります。

JmsConsumerClose MessageConsumerオブジェクトを閉じます
JmsConsumerGetMessageListener MessageConsumerオブジェクトからメッセージリスナーオブジェクトを取得します。
JmsConsumerGetMessageSelector MessageConsumerオブジェクトからメッセージセレクタ式を取得します。
JmsConsumerReceive メッセージを受信します
JmsConsumerReceiveNoWait 直ちにメッセージを受信します
JmsConsumerSetMessageListener MessageListenerを設定します

 
3.2.3.10.1. JmsConsumerClose
名称 JmsConsumerClose - オブジェクトを閉じます
形式 WOJMSStatus JmsConsumerClose( JmsConsumer *consumer );
説明 consumerで指定したJmsConsumer構造体に指定されているMessageConsumerオブジェクトを閉じます。 JMSプロバイダは、MessageConsumer対応するリソースをJVM外部に割り当てる場合があるため、リソースが不要になった場合、クライアントがリソースを閉じる必要があります。
引数 I/O パラメータ 説明
I consumer MessageConsumerオブジェクトを指すJmsConsumer構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageConsumerオブジェクトが無効です。
関連項目 javax.jms.MessageConsumer.close()
 
3.2.3.10.2. JmsConsumerGetMessageListener
名称 JmsConsumerGetMessageListener - MessageConsumerオブジェクトからメッセージリスナーオブジェクトを取得します。
形式 WOJMSStatus JmsConsumerGetMessageListener( JmsConsumer *consumer, JmsMessageListenerFunc *messageListener );
説明 consumerで指定したMessageConsumerオブジェクトに登録されたJmsMessageListenerFunc型の関数ポインタを取得し、引数messageListenerに格納します。
引数 I/O パラメータ 説明
I consumer MessageConsumerオブジェクトを指すJmsConsumer構造体へのポインタを指定します。
O messageListener 取得したメッセージリスナーオブジェクトが格納されます。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
関連項目 javax.jms.MessageConsumer.getMessageListener()
 
3.2.3.10.3. JmsConsumerGetMessageSelector
名称 JmsConsumerGetMessageSelector - MessageConsumerオブジェクトからメッセージセレクタ式を取得します。
形式 WOJMSStatus JmsConsumerGetMessageSelector( JmsConsumer *consumer, JmsString *selector );
説明 consumerで指定したMessageConsumerオブジェクトからメッセージセレクタ式を取得し、引数selectorに格納します。
引数 I/O パラメータ 説明
I consumer MessageConsumerオブジェクトを指すJmsConsumer構造体へのポインタを指定します。
O selector 取得したメッセージセレクタ式を格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageConsumerオブジェクトが無効です。
関連項目 javax.jms.MessageConsumer.getMessageSelector()
 
3.2.3.10.4. JmsConsumerReceive
名称 JmsConsumerReceive - メッセージを受信します
形式 WOJMSStatus JmsConsumerReceive( JmsConsumer *consumer, JmsMessage *message, WOJMS_LONG timeout );
説明 consumerで指定したMessageConsumerオブジェクトのreceiveメソッドに、timeout引数を指定してメッセージを受信します。timeout をゼロに設定すると無期限に実行します。
引数 I/O パラメータ 説明
I consumer receiveメソッドを呼び出すMessageConsumerオブジェクトを指すJmsConsumer構造体へのポインタを指定します。
O message 受信したメッセージを受け取るためのJmsMessage構造体を指すポインタを指定します。関数が正常終了した場合、JmsMessage構造体のmessageTypeフィールドに受信したメッセージタイプが格納されます。メッセージタイプとして次の値が定義されています。
定義名 値
WOJMS_MESSAGE_UNKNOWN 0
WOJMS_MESSAGE 1
WOJMS_MESSAGE_BYTES 2
WOJMS_MESSAGE_MAP 3
WOJMS_MESSAGE_OBJECT 4
WOJMS_MESSAGE_STREAM 5
WOJMS_MESSAGE_TEXT 6
I timeout タイムアウト値 (ミリ秒)を指定します。ゼロに設定すると有効期限切れになることはないため、この呼び出しは無期限に実行します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageConsumerオブジェクトが無効です。
関連項目 javax.jms.MessageConsumer.receive(long)
 
3.2.3.10.5. JmsConsumerReceiveNoWait
名称 JmsConsumerReceiveNoWait - 直ちにメッセージを受信します
形式 WOJMSStatus JmsConsumerReceiveNoWait( JmsConsumer *consumer, JmsMessage *message );
説明 consumerで指定したMessageConsumerオブジェクトのreceiveNoWaitメソッドを呼び出し直ちにメッセージを受信します。
引数 I/O パラメータ 説明
I consumer receiveNoWaitメソッドを呼び出すMessageConsumerオブジェクトを指すJmsConsumer構造体へのポインタを指定します。
O message 受信したメッセージを受け取るためのJmsMessage構造体を指すポインタを指定します。NULLの場合は、メッセージが存在しないことを意味します。関数が正常終了し、messageがNULLでない場合、JmsMessage構造体のmessageTypeフィールドに受信したメッセージタイプが格納されます。メッセージタイプとして次の値が定義されています。
定義名 値
WOJMS_MESSAGE_UNKNOWN 0
WOJMS_MESSAGE 1
WOJMS_MESSAGE_BYTES 2
WOJMS_MESSAGE_MAP 3
WOJMS_MESSAGE_OBJECT 4
WOJMS_MESSAGE_STREAM 5
WOJMS_MESSAGE_TEXT 6
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageConsumerオブジェクトが無効です。
関連項目 javax.jms.MessageConsumer.receiveNoWait()
 
3.2.3.10.6. JmsConsumerSetMessageListener
名称 JmsConsumerSetMessageListener - MessageListenerを設定します
形式 WOJMSStatus JmsConsumerSetMessageListener( JmsConsumer *consumer, JmsMessageListenerFunc messageListener );
説明 consumerで指定したMessageConsumerオブジェクトのsetMessageListenerメソッドに、messageListener引数を指定してMessageListenerオブジェクトを登録します。 messageListenerをNULLに設定すると、MessageListenerの設定を解除することが可能です。
引数 I/O パラメータ 説明
I consumer setMessageListenerメソッドを呼び出すMessageConsumerオブジェクトを指すJmsConsumer構造体へのポインタを指定します。
I messageListener 非同期にMessageが配信された際にコールバックされるJmsMessageListenerFunc型の関数ポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageConsumerオブジェクトが無効です。
関連項目 javax.jms.MessageConsumer.setMessageListener(javax.jms.MessageListener)

3.2.3.11. MessageProducerインタフェース

MessageProducerインタフェースは、C言語ランタイムライブラリにてJMSのMessageProducerオブジェクトへのインタフェースを提供します。

MessageProducerインタフェースには次の関数があります。

JmsProducerClose MessageProducerオブジェクトを閉じます
JmsProducerGetDeliveryMode MessageProducerオブジェクトからデフォルトの配信モードを取得します。
JmsProducerGetDestination MessageProducerオブジェクトに関連付けられた送信先オブジェクトを取得します。
JmsProducerGetDisableMessageID MessageProducerオブジェクトでメッセージIDが無効かどうかを示す指示状態を取得します。
JmsProducerGetDisableMessageTimestamp MessageProducerオブジェクトでタイムスタンプが無効かどうかを示す指示状態を取得します。
JmsProducerGetPriority MessageProducerオブジェクトのデフォルトの優先度を取得します。
JmsProducerGetTimeToLive MessageProducerオブジェクトから送信されたメッセージがメッセージシステムに保存される、有効期限を取得します。
JmsProducerSend メッセージを送信します
JmsProducerSetDeliveryMode MessageProducerオブジェクトにデフォルトの配信モードを設定します。
JmsProducerSetDisableMessageID MessageProducerオブジェクトにメッセージIDを無効にするかどうかの設定を行います。
JmsProducerSetDisableMessageTimestamp MessageProducerオブジェクトにタイムスタンプを無効にするかどうかの設定を行います。
JmsProducerSetPriority MessageProducerオブジェクトにデフォルトの優先度を設定します。
JmsProducerSetTimeToLive MessageProducerオブジェクトから送信されたメッセージの、メッセージシステムに保存されるデフォルトの有効期限を設定します。

 
3.2.3.11.1. JmsProducerClose
名称 JmsProducerClose - MessageProducerオブジェクトを閉じます
形式 WOJMSStatus JmsProducerClose( JmsProducer *producer );
説明 producerで指定したJmsProducer構造体に指定されているMessageProducerオブジェクトを閉じます。 JMSプロバイダは、MessageProducerに対応するリソースをJVM外部に割り当てる場合があるため、リソースが不要になった場合、クライアントがリソースを閉じる必要があります。
引数 I/O パラメータ 説明
I producer closeメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.close()
 
3.2.3.11.2. JmsProducerGetDeliveryMode
名称 JmsProducerGetDeliveryMode - MessageProducerオブジェクトからデフォルトの配信モードを取得します。
形式 WOJMSStatus JmsProducerGetDeliveryMode( JmsProducer *producer, WOJMS_INT *deliveryMode );
説明 producerで指定したJmsProducerオブジェクトに指定されているデフォルトのメッセージ配信モードを取得し、引数deliveryModeに格納します。
引数 I/O パラメータ 説明
I producer getDeliveryModeメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
O deliveryMode 取得したメッセージ配信モードを格納するWOJMS_INTへのポインタを指定します。
WOJMS_DELIVERYMODE_NON_PERSISTENT: メッセージを安定記憶領域に記録する必要がないため、オーバーヘッドがもっとも低くなります。 WOJMS_DELIVERYMODE_PERSISTENT: JMSプロバイダに対し、クライアントの送信操作の一部としてメッセージを安定記憶領域に記録されます。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.getDeliveryMode()
 
3.2.3.11.3. JmsProducerGetDestination
名称 JmsProducerGetDestination - MessageProducerオブジェクトに関連付けられた送信先オブジェクトを取得します。
形式 WOJMSStatus JmsProducerGetDestination( JmsProducer *producer, JmsDestination *destination );
説明 producerで指定したJmsProducerオブジェクトに関連付けされている送信先オブジェクトを取得し、引数destinationに格納します。
引数 I/O パラメータ 説明
I producer getDestinationメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
O destination 取得した送信先オブジェクトを格納する、JmsDestination構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.getDestination()
 
3.2.3.11.4. JmsProducerGetDisableMessageID
名称 JmsProducerGetDisableMessageID - MessageProducerオブジェクトでメッセージIDが無効かどうかを示す指示状態を取得します。
形式 WOJMSStatus JmsProducerGetDisableMessageID( JmsProducer *producer, WOJMS_BOOL *value );
説明 producerで指定したJmsProducerオブジェクトでメッセージIDが無効かどうかを示す指示状態を取得し、valueに格納します。
引数 I/O パラメータ 説明
I producer getDisableMessageIDメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
O value 取得した指示状態を格納する、WOJMS_BOOLへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.getDisableMessageID()
 
3.2.3.11.5. JmsProducerGetDisableMessageTimestamp
名称 JmsProducerGetDisableMessageTimestamp - MessageProducerオブジェクトでタイムスタンプが無効かどうかを示す指示状態を取得します。
形式 WOJMSStatus JmsProducerGetDisableMessageTimestamp( JmsProducer *producer, WOJMS_BOOL *value );
説明 producerで指定したJmsProducerオブジェクトから、タイムスタンプが無効かどうかを示す指示状態を取得し、引数valueに格納します。
引数 I/O パラメータ 説明
I producer getDisableMessageTimestampメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
O value 取得した指示状態を格納する、WOJMS_BOOLへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.getDisableMessageTimestamp()
 
3.2.3.11.6. JmsProducerGetPriority
名称 JmsProducerGetPriority - MessageProducerオブジェクトのデフォルトの優先度を取得します。
形式 WOJMSStatus JmsProducerGetPriority( JmsProducer *producer, WOJMS_INT *defaultPriority );
説明 producerで指定したMessageProducerオブジェクトから優先度を取得し、引数defaultPriorityに格納します。
引数 I/O パラメータ 説明
I producer getPriorityメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
O defaultPriority 取得した優先度を格納する、WOJMS_INTへのポインタを指定します。
メッセージの優先度(0から9)は、低い優先度が0、最も高い優先度が9で、デフォルトは4です。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.getPriority()
 
3.2.3.11.7. JmsProducerGetTimeToLive
名称 JmsProducerGetTimeToLive - MessageProducerオブジェクトから送信されたメッセージがメッセージシステムに保存される、有効期限を取得します。
形式 WOJMSStatus JmsProducerGetTimeToLive( JmsProducer *producer, WOJMS_LONG *timeToLive );
説明 producerで指定したJmsProducerオブジェクトから送信メッセージの有効期限を取得し、引数timeToLiveに格納します。
引数 I/O パラメータ 説明
I producer getTimeToLiveメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
O timeToLive 取得したメッセージの有効期限を格納する、WOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.getTimeToLive()
 
3.2.3.11.8. JmsProducerSend
名称 JmsProducerSend - メッセージを送信します
形式 WOJMSStatus JmsProducerSend( JmsProducer *producer, JmsMessage *message, WOJMS_INT deliveryMode, WOJMS_INT priority, WOJMS_LONG timeToLive );
説明 producerで指定したMessageProducerオブジェクトのsendメソッドに、message、deliveryMode、priority、timeToLive引数を指定してメッセージを送信します。
引数 I/O パラメータ 説明
I producer sendメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
I message Messageオブジェクトを指すJmsMessage構造体へのポインタを指定します。
I deliveryMode 使用する配信モードを指定します。
WOJMS_DELIVERYMODE_NON_PERSISTENT: メッセージを安定記憶領域に記録する必要がないため、オーバーヘッドがもっとも低くなります。
WOJMS_DELIVERYMODE_PERSISTENT: JMSプロバイダに対し、クライアントの送信操作の一部としてメッセージを安定記憶領域に記録するよう指示します。
I priority メッセージの優先度(0から9)を指定します。低い優先度が0、最も高い優先度が9で、デフォルトは4です。
I timeToLive メッセージの有効期間 (ミリ秒) を指定します。ゼロが指定された場合、メッセージの期限は無制限です。デフォルトはゼロになります。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.send(javax.jms.Message, int, int, long)
 
3.2.3.11.9. JmsProducerSetDeliveryMode
名称 JmsProducerSetDeliveryMode - MessageProducerオブジェクトにデフォルトの配信モードを設定します。
形式 WOJMSStatus JmsProducerSetDeliveryMode( JmsProducer *producer, WOJMS_INT deliveryMode );
説明 producerで指定したJmsProducerオブジェクトに引数deliveryModeに指定されている配信モードを設定します。
引数 I/O パラメータ 説明
I producer setDeliveryModeメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
I deliveryMode JmsProducerオブジェクトに設定する配信モードを指定します。
WOJMS_DELIVERYMODE_NON_PERSISTENT: メッセージを安定記憶領域に記録する必要がないため、オーバーヘッドがもっとも低くなります。
WOJMS_DELIVERYMODE_PERSISTENT: JMSプロバイダに対し、クライアントの送信操作の一部としてメッセージを安定記憶領域に記録するよう指示します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.setDeliveryMode(int)
 
3.2.3.11.10. JmsProducerSetDisableMessageID
名称 JmsProducerSetDisableMessageID - MessageProducerオブジェクトにメッセージIDを無効にするかどうかの設定を行います。
形式 WOJMSStatus JmsProducerSetDisableMessageID( JmsProducer *producer, WOJMS_BOOL value );
説明 producerで指定したJmsProducerオブジェクトに、引数valueで指定されているメッセージIDを無効にするかどうかの指示を設定します。
引数 I/O パラメータ 説明
I producer setDisableMessageIDメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
I value メッセージIDを無効にするかどうかを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.setDisableMessageID(boolean)
 
3.2.3.11.11. JmsProducerSetDisableMessageTimestamp
名称 JmsProducerSetDisableMessageTimestamp - MessageProducerオブジェクトにタイムスタンプを無効にするかどうかの設定を行います。
形式 WOJMSStatus JmsProducerSetDisableMessageTimestamp( JmsProducer *producer, WOJMS_BOOL value );
説明 producerで指定したJmsProducerオブジェクトに引数valueで指定した、タイムスタンプを無効にするかどうかの指示を設定します。
引数 I/O パラメータ 説明
I producer setDisableMessageTimestampメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
I value タイムスタンプを無効にするかどうかを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.setDisableMessageTimestamp(boolean)
 
3.2.3.11.12. JmsProducerSetPriority
名称 JmsProducerSetPriority - MessageProducerオブジェクトにデフォルトの優先度を設定します。
形式 WOJMSStatus JmsProducerSetPriority( JmsProducer *producer, WOJMS_INT defaultPriority );
説明 producerで指定したJmsProducerオブジェクトに、引数defaultPriorityで指定されているメッセージ優先度を設定します。
引数 I/O パラメータ 説明
I producer setPriorityメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
I defaultPriority メッセージ優先度を指定します。
メッセージの優先度(0から9)は、低い優先度が0、最も高い優先度が9で、デフォルトは4です。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.setPriority(int)
 
3.2.3.11.13. JmsProducerSetTimeToLive
名称 JmsProducerSetTimeToLive - MessageProducerオブジェクトから送信されたメッセージの、メッセージシステムに保存されるデフォルトの有効期限を設定します。
形式 WOJMSStatus JmsProducerSetTimeToLive( JmsProducer *producer, WOJMS_LONG timeToLive );
説明 producerで指定したJmsProducerオブジェクトに引数timeToLiveで指定されている、メッセージの有効期限を設定します。
引数 I/O パラメータ 説明
I producer setTimeToLiveメソッドを呼び出すMessageProducerオブジェクトを指すJmsProducer構造体へのポインタを指定します。
I timeToLive メッセージの有効期限を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 MessageProducerオブジェクトが無効です。
関連項目 javax.jms.MessageProducer.setTimeToLive(long)

3.2.3.12. ObjectMessageインタフェース

ObjectMessageインタフェースは、C言語ランタイムライブラリにてJMSのObjectMessageオブジェクトへのインタフェースを提供します。

ObjectMessageインタフェースには次の関数があります。

JmsObjectMessageDestroy StreamMessageオブジェクトを破棄します。
JmsObjectMessageGetObject StreamMessageオブジェクトからjavaオブジェクトを取得します。
JmsObjectMessageSetObject StreamMessageオブジェクトにjavaオブジェクトを設定します。

 
3.2.3.12.1. JmsObjectMessageDestroy
名称 JmsObjectMessageDestroy - StreamMessageオブジェクトを破棄します。
形式 WOJMSStatus JmsObjectMessageDestroy( JmsObjectMessage *message );
説明 messageで指定したJmsObjectMessage構造体に指定されているObjectMessageオブジェクトを破棄します。
引数 I/O パラメータ 説明
I message ObjectMessageオブジェクトを指すJmsObjectMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.12.2. JmsObjectMessageGetObject
名称 JmsObjectMessageGetObject - StreamMessageオブジェクトからjavaオブジェクトを取得します。
形式 WOJMSStatus JmsObjectMessageGetObject( JmsObjectMessage *message, WOJMS_OBJECT *value );
説明 messageで指定したJmsObjectMessage構造体からjavaオブジェクトを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message ObjectMessageオブジェクトを指すJmsObjectMessage構造体へのポインタを指定します。
O value 取得したjavaオブジェクトを格納するWOJMS_OBJECTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionFactoryオブジェクトが無効です。
関連項目 javax.jms.ObjectMessage.getObject()
 
3.2.3.12.3. JmsObjectMessageSetObject
名称 JmsObjectMessageSetObject - StreamMessageオブジェクトにjavaオブジェクトを設定します。
形式 WOJMSStatus JmsObjectMessageSetObject( JmsObjectMessage *message, WOJMS_OBJECT value );
説明 messageで指定したJmsObjectMessage構造体に、引数valueで指定したjavaオブジェクトを設定します。
引数 I/O パラメータ 説明
I message ObjectMessageオブジェクトを指すJmsObjectMessage構造体へのポインタを指定します。
I value 設定するjavaオブジェクトを格納するWOJMS_OBJECTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 ConnectionFactoryオブジェクトが無効です。
関連項目 javax.jms.ObjectMessage.setObject(java.io.Serializable)

3.2.3.13. Queueインタフェース

Queueインタフェースは、C言語ランタイムライブラリにてJMSのQueueオブジェクトへのインタフェースを提供します。

Queueインタフェースには次の関数があります。

JmsQueueDestroy Queueオブジェクトを破棄します
JmsQueueGetQueueName Queueオブジェクトから名前を取得します。
JmsTemporaryQueueDelete 一時送信先として生成されたQueueオブジェクトを破棄します。

 
3.2.3.13.1. JmsQueueDestroy
名称 JmsQueueDestroy - Queueオブジェクトを破棄します
形式 WOJMSStatus JmsQueueDestroy( JmsQueue *queue );
説明 queueで指定したJmsQueue構造体に指定されているQueueオブジェクトを破棄します。
引数 I/O パラメータ 説明
I queue Queueオブジェクトを指すJmsQueue構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.13.2. JmsQueueGetQueueName
名称 JmsQueueGetQueueName - Queueオブジェクトから名前を取得します。
形式 WOJMSStatus JmsQueueGetQueueName( JmsQueue *queue, JmsString *name );
説明 queueで指定したJmsQueue構造体から送信先名を取得し、引数nameに格納します。
引数 I/O パラメータ 説明
I queue Queueオブジェクトを指すJmsQueue構造体へのポインタを指定します。
O name 取得した送信先名を格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Queueオブジェクトが無効です。
関連項目 javax.jms.Queue.getQueueName()
 
3.2.3.13.3. JmsTemporaryQueueDelete
名称 JmsTemporaryQueueDelete - 一時送信先として生成されたQueueオブジェクトを破棄します。
形式 WOJMSStatus JmsTemporaryQueueDelete( JmsTemporaryQueue *queue );
説明 一時送信先である、queueで指定したJmsTemporaryQueue構造体に指定されているTemporaryQueueオブジェクトを破棄します。
引数 I/O パラメータ 説明
I queue TemporaryQueueオブジェクトを指すJmsTemporaryQueue構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 TemporaryQueueオブジェクトが無効です。
関連項目 javax.jms.TemporaryQueue.delete()

3.2.3.14. QueueBrowserインタフェース

QueueBrowserインタフェースは、C言語ランタイムライブラリにてJMSのQueueBrowserオブジェクトへのインタフェースを提供します。

QueueBrowserインタフェースには次の関数があります。

JmsQueueBrowserClose QueueBrowserオブジェクトを閉じます。
JmsQueueBrowserGetEnumeration QueueBrowserオブジェクトからキューメッセージのリストを受信順に表示します。
JmsQueueBrowserGetMessageSelector QueueBrowserオブジェクトのメッセージセレクタ式を取得します。
JmsQueueBrowserGetQueue QueueBrowserオブジェクトに関連付けられた送信先オブジェクトを取得します。

 
3.2.3.14.1. JmsQueueBrowserClose
名称 JmsQueueBrowserClose - QueueBrowserオブジェクトを閉じます。
形式 WOJMSStatus JmsQueueBrowserClose( JmsQueueBrowser *browser );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトを閉じます。 プロバイダは QueueBrowser に対応するリソースを Java 仮想マシン外部に割り当てる場合があるため、これらのリソースが不要になった場合、クライアントがリソースを閉じる必要があります。
引数 I/O パラメータ 説明
I browser closeメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.close()
 
3.2.3.14.2. JmsQueueBrowserGetEnumeration
名称 JmsQueueBrowserGetEnumeration - QueueBrowserオブジェクトからキューメッセージのリストを受信順に表示します。
形式 WOJMSStatus JmsQueueBrowserGetEnumeration( JmsQueueBrowser *browser, JmsEnumeration *enumeration );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトから現在のキューメッセージの表示用列挙を受信順に取得し、引数enumerationに格納します。
引数 I/O パラメータ 説明
I browser getEnumerationメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
O enumeration 取得したキューメッセージ群を格納するJmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.getEnumeration()
 
3.2.3.14.3. JmsQueueBrowserGetMessageSelector
名称 JmsQueueBrowserGetMessageSelector - QueueBrowserオブジェクトのメッセージセレクタ式を取得します。
形式 WOJMSStatus JmsQueueBrowserGetMessageSelector( JmsQueueBrowser *browser, JmsString *selector );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトからメッセージセレクタ式を取得し、引数selectorに格納します。
引数 I/O パラメータ 説明
I browser getMessageSelectorメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
O selector 取得したメッセージセレクタ式を格納する、JmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.getMessageSelector()
 
3.2.3.14.4. JmsQueueBrowserGetQueue
名称 JmsQueueBrowserGetQueue - QueueBrowserオブジェクトに関連付けられた送信先オブジェクトを取得します。
形式 WOJMSStatus JmsQueueBrowserGetQueue( JmsQueueBrowser *browser, JmsQueue *queue );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトに関連付けられた送信先オブジェクトを取得し、引数queueに格納します。
引数 I/O パラメータ 説明
I browser getQueueメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
O queue 取得した送信先オブジェクトを格納する、JmsQueue構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.getQueue()

3.2.3.15. Sessionインタフェース

Sessionインタフェースは、C言語ランタイムライブラリにてJMSのSessionオブジェクトへのインタフェースを提供します。

Sessionインタフェースには次の関数があります。

JmsSessionClose Sessionオブジェクトを閉じます
JmsSessionCommit Sessionオブジェクトのトランザクションで実行されたメッセージをコミットします。
JmsSessionCreateBrowser QueueBrowserオブジェクトを生成します
JmsSessionCreateBytesMessage BytesMessageオブジェクトを生成します。
JmsSessionCreateConsumer MessageConsumerオブジェクトを生成します
JmsSessionCreateDurableSubscriber 持続性サブスクライバオブジェクトを生成します。
JmsSessionCreateMapMessage MapMessageオブジェクトを生成します。
JmsSessionCreateMessage Messageオブジェクトを生成します。
JmsSessionCreateObjectMessage ObjectMessageオブジェクトを生成します。
JmsSessionCreateProducer MessageProducerオブジェクトを生成します
JmsSessionCreateQueue Queueオブジェクトを生成します
JmsSessionCreateStreamMessage StreamMessageオブジェクトを生成します。
JmsSessionCreateTemporaryQueue TemporaryQueueオブジェクトを生成します。
JmsSessionCreateTemporaryTopic TemporaryTopicオブジェクトを生成します。
JmsSessionCreateTextMessage TextMessageオブジェクトを生成します
JmsSessionCreateTopic Topicオブジェクトを生成します
JmsSessionGetAcknowledgeMode Sessionオブジェクトの確認応答モードを返します。
JmsSessionGetTransacted Sessionオブジェクトがトランザクションモードであるかどうかを示します。
JmsSessionRecover Sessionオブジェクト内のメッセージ配信を停止し、もっとも古い未確認応答のメッセージを使用してメッセージ配信を再開します。
JmsSessionRollback Sessionオブジェクトのトランザクションで実行されたメッセージをロールバックします。
JmsSessionUnsubscribe クライアントにより生成された持続性サブスクリプションを解除します。

 
3.2.3.15.1. JmsSessionClose
名称 JmsSessionClose - Sessionオブジェクトを閉じます
形式 WOJMSStatus JmsSessionClose( JmsSession *session );
説明 sessionで指定したJmsSession構造体に指定されているSessionオブジェクトを閉じます。 JMSプロバイダは、Sessionに対応するリソースをJVM外部に割り当てる場合があるため、リソースが不要になった場合、クライアントがリソースを閉じる必要があります。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.close()
 
3.2.3.15.2. JmsSessionCommit
名称 JmsSessionCommit - Sessionオブジェクトのトランザクションで実行されたメッセージをてコミットします。
形式 WOJMSStatus JmsSessionCommit( JmsSession *session );
説明 sessionで指定したJmsSession構造体に指定されている、Sessionオブジェクトのトランザクションで実行されたメッセージをすべてコミットし、設定中のロックをすべて解放します。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.commit()
 
3.2.3.15.3. JmsSessionCreateBrowser
名称 JmsSessionCreateBrowser - QueueBrowserオブジェクトを生成します
形式 WOJMSStatus JmsSessionCreateBrowser( JmsSession *session, JmsQueueBrowser *browser, JmsQueue *queue, JmsString *messageSelector );
説明 sessionで指定したJmsSession構造体に指定されている、SessionオブジェクトのcreateBrowserメソッドをqueue引数を指定して呼び出し、QueueBrowserオブジェクトを生成します。QueueBrowserオブジェクトは、messageSelectorで指定したメッセージセレクタを使用してキューのメッセージを調べます。生成したQueueBrowserオブジェクトは、QueueBrowserで指定したJmsQueueBrowser構造体に設定して返却されます。
引数 I/O パラメータ 説明
I session createBrowserを呼び出すQueueSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O browser 生成したQueueBrowserオブジェクトを受け取るためのJmsQueueBrowser構造体を指すポインタを指定します。
I queue 送信先の情報を持っているJmsQueue構造体へのポインタを指定します。
I messageSelector 特定のメッセージだけ配信できるようにするセレクタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createBrowser(javax.jms.Session.Queue, java.lang.String)
 
3.2.3.15.4. JmsSessionCreateBytesMessage
名称 JmsSessionCreateBytesMessage - BytesMessageオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateBytesMessage( JmsSession *session, JmsBytesMessage *message );
説明 sessionで指定したJmsSession構造体に指定されている、SessionオブジェクトのcreateBytesMessageを呼び出し、 BytesMessage オブジェクトを作成します。BytesMessage オブジェクトを使用して、未解釈のバイトストリームを含むメッセージを送信できます。
引数 I/O パラメータ 説明
I session createBytesMessageメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O message 生成したBytesMessageオブジェクトを受け取るためのJmsBytesMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createBytesMessage()
 
3.2.3.15.5. JmsSessionCreateConsumer
名称 JmsSessionCreateConsumer - MessageConsumerオブジェクトを生成します
形式 WOJMSStatus JmsSessionCreateConsumer( JmsSession *session, JmsConsumer *consumer, JmsDestination *destination, JmsString *messageSelector, WOJMS_BOOL noLocal );
説明 sessionで指定したSessionオブジェクトのcreateConsumerメソッドを、destination、messageSelector、noLocal引数を指定して呼び出し、MessageConsumerオブジェクトを生成します。生成したMessageConsumerオブジェクトは、consumerで指定したJmsConsumer構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createConsumerメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O consumer 生成したMessageConsumerオブジェクトを受け取るためのJmsConsumer構造体を指すポインタを指定します。
I destination 送信先の情報を持っているJmsDestination構造体のポインタを指定します。
I messageSelector 特定のメッセージだけ受信できるようにするセレクタを指定します。
I noLocal コンシューマが使用しているコネクションと同じコネクションで送信されたメッセージの受信を抑止するかどうかを指定します。(Topicの際に有効)
WOJMS_TRUE：抑止する
WOJMS_FALSE：抑止しない
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createConsumer(javax.jms.Destination, java.lang.String, boolean)
 
3.2.3.15.6. JmsSessionCreateDurableSubscriber
名称 JmsSessionCreateDurableSubscriber - 持続性サブスクライバオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateDurableSubscriber( JmsSession *session, JmsTopicSubscriber *subscriber, JmsTopic *topic, JmsString *name, JmsString *messageSelector, WOJMS_BOOL noLocal );
説明 sessionで指定したSessionオブジェクトのcreateDurablesubscriberメソッドを、destination、messageSelector、noLocal引数を指定して呼び出し、TopicSubscriberオブジェクトを生成します。生成したTopicSubscriberオブジェクトは、subscriberで指定したJmsTopicSubscriber構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createDurablesubscriberメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O subscriber 生成したTopicSubscriberオブジェクトを受け取るためのJmsTopicSubscriber構造体を指すポインタを指定します。
I topic 送信先の情報を持っているJmsTopic構造体のポインタを指定します。
I name 生成するTopicSubscriberオブジェクトの識別に使用する名前を指定します。
I messageSelector 特定のメッセージだけ受信できるようにするセレクタを指定します。
I noLocal サブスクライバが使用しているコネクションと同じコネクションで送信されたメッセージの受信を抑止するかどうかを指定します。(Topicの際に有効)
WOJMS_TRUE：抑止する
WOJMS_FALSE：抑止しない
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createDurableSubscriber(javax.jms.Topic, java.lang.String, String, boolean)
 
3.2.3.15.7. JmsSessionCreateMapMessage
名称 JmsSessionCreateMapMessage - MapMessageオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateMapMessage( JmsSession *session, JmsMapMessage *message );
説明 sessionで指定したJmsSession構造体に指定されている、SessionオブジェクトのcreateMapMessageを呼び出し、 MapMessageオブジェクトを作成します。MapMessage オブジェクトを使用して、自己定義型の名前と値のペアのセットを送信できます。
引数 I/O パラメータ 説明
I session createMapMessageメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O message 生成したMapMessageオブジェクトを受け取るためのJmsMapMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createMapMessage()
 
3.2.3.15.8. JmsSessionCreateMessage
名称 JmsSessionCreateMessage - Messageオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateMessage( JmsSession *session, JmsMessage *message );
説明 sessionで指定したJmsSession構造体に指定されている、SessionオブジェクトのcreateMessageを呼び出し、 Messageオブジェクトを生成します。Messageオブジェクトは、ヘッダ情報のみを含むメッセージで十分な場合に送信可能です。
引数 I/O パラメータ 説明
I session createMessageメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O message 生成したMessageオブジェクトを受け取るためのJmsMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createMessage()
 
3.2.3.15.9. JmsSessionCreateObjectMessage
名称 JmsSessionCreateObjectMessage - ObjectMessageオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateObjectMessage( JmsSession *session, JmsObjectMessage *message );
説明 sessionで指定したJmsSession構造体に指定されている、SessionオブジェクトのcreateMessageを呼び出し、 ObjectMessageオブジェクトを生成します。
引数 I/O パラメータ 説明
I session createObjectMessageメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O message 生成したObjectMessageオブジェクトを受け取るためのJmsObjectMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createObjectMessage()
 
3.2.3.15.10. JmsSessionCreateProducer
名称 JmsSessionCreateProducer - MessageProducerオブジェクトを生成します
形式 WOJMSStatus JmsSessionCreateProducer( JmsSession *session, JmsProducer *producer, JmsDestination *destination );
説明 sessionで指定したSessionオブジェクトのcreateProducerメソッドを、destination引数を指定して呼び出し、MessageProducerオブジェクトを生成します。生成したMessageProducerオブジェクトは、producerで指定したJmsProducer構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createProducerメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O producer 生成したMessageProducerオブジェクトを受け取るためのJmsProducer構造体を指すポインタを指定します。
I destination 送信先の情報を持っているJmsDestination構造体のポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createProducer(javax.jms.Destination)
 
3.2.3.15.11. JmsSessionCreateQueue
名称 JmsSessionCreateQueue - Queueオブジェクトを生成します
形式 WOJMSStatus JmsSessionCreateQueue( JmsSession *session, JmsQueue *queue, char *queueName );
説明 sessionで指定したSessionオブジェクトのcreateQueueメソッドを、queueName引数を指定して呼び出し、Queueオブジェクトを生成します。生成したQueueオブジェクトは、queueで指定したJmsQueue構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createQueueメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O queue 生成したQueueオブジェクトを受け取るためのJmsQueue構造体を指すポインタを指定します。
I queueName Queueの名前を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createQueue(java.lang.String)
 
3.2.3.15.12. JmsSessionCreateStreamMessage
名称 JmsSessionCreateStreamMessage - StreamMessageオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateStreamMessage( JmsSession *session, JmsStreamMessage *message );
説明 sessionで指定したJmsSession構造体に指定されている、SessionオブジェクトのcreateStreamMessageを呼び出し、 StreamMessageオブジェクトを生成します。StreamMessageオブジェクトを使用して、自己定義型のストリームを送信できます。
引数 I/O パラメータ 説明
I session createStreamMessageメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O message 生成したStreamMesseageオブジェクトを受け取るためのJmsStreamMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createStreamMessage()
 
3.2.3.15.13. JmsSessionCreateTemporaryQueue
名称 JmsSessionCreateTemporaryQueue - TemporaryQueueオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateTemporaryQueue( JmsSession *session, JmsTemporaryQueue *queue );
説明 sessionで指定したSessionオブジェクトのcreateTemporaryQueueメソッドを呼び出し、TemporaryQueueオブジェクトを生成します。生成したTemporaryQueueオブジェクトは、queueで指定したJmsTemporaryQueue構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createTemporaryQueueメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O queue 生成したTemporaryQueueオブジェクトを受け取るためのJmsQueue構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createTemporaryQueue()
 
3.2.3.15.14. JmsSessionCreateTemporaryTopic
名称 JmsSessionCreateTemporaryTopic - TemporaryTopicオブジェクトを生成します。
形式 WOJMSStatus JmsSessionCreateTemporaryTopic( JmsSession *session, JmsTemporaryTopic *topic );
説明 sessionで指定したSessionオブジェクトのcreateTopicメソッドを呼び出し、TemporaryTopicオブジェクトを生成します。生成したTemporaryTopicオブジェクトは、topicで指定したJmsTemporaryTopic構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createTemporaryTopicメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O topic 生成したTemporaryTopicオブジェクトを受け取るためのJmsTemporaryTopic構造体を指すポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createTemporaryTopic()
 
3.2.3.15.15. JmsSessionCreateTextMessage
名称 JmsSessionCreateTextMessage - TextMessageオブジェクトを生成します
形式 WOJMSStatus JmsSessionCreateTextMessage( JmsSession *session, JmsTextMessage *message, JmsString *text );
説明 sessionで指定したSessionオブジェクトのcreateTextMessageメソッドを、text引数を指定して呼び出し、TextMessageオブジェクトを生成します。生成したTextMessageオブジェクトは、messageで指定したJmsTextMessage構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createTextMessageメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O message 生成したTextMessageオブジェクトを受け取るためのJmsTextMessage構造体を指すポインタを指定します。
I text このメッセージの初期化に使用する文字列を指定します。NULLを指定した場合は文字列データで初期化せずにメッセージを生成します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 javax.jms.Session.createTextMessage(java.lang.String)
 
3.2.3.15.16. JmsSessionCreateTopic
名称 JmsSessionCreateTopic - Topicオブジェクトを生成します
形式 WOJMSStatus JmsSessionCreateTopic( JmsSession *session, JmsTopic *topic, char *topicName );
説明 sessionで指定したSessionオブジェクトのcreateTopicメソッドを、topicName引数を指定して呼び出し、Topicオブジェクトを生成します。生成したTopicオブジェクトは、topicで指定したJmsTopic構造体に設定して返却します。
引数 I/O パラメータ 説明
I session createTopicメソッドを呼び出すSessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O topic 生成したTopicオブジェクトを受け取るためのJmsTopic構造体を指すポインタを指定します。
I topicName Topicの名前を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.createTopic(java.lang.String)
 
3.2.3.15.17. JmsSessionGetAcknowledgeMode
名称 JmsSessionGetAcknowledgeMode - Sessionオブジェクトの確認応答モードを返します。
形式 WOJMSStatus JmsSessionGetAcknowledgeMode( JmsSession *session, WOJMS_INT *value );
説明 sessionで指定したSessionオブジェクトのgetAcknowledgeModeメソッドを呼び出し、Sessionオブジェクトの確認応答モードを取得します。取得した値は、引数valueに格納します。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O value 取得したSessionオブジェクトの確認応答モードを格納するWOJMS_INTへのポインタを指定します。
WOJMS_AUTO_ACKNOWLEDGE：自動確認応答モード(再送要求不可)
WOJMS_CLIENT_ACKNOWLEDGE：インタフェース確認モード
WOJMS_DUPS_OK_ACKNOWLEDGE：自動確認応答モード
WOJMS_NO_ACKNOWLEDGE：確認応答なしモード
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.getAcknowledgeMode()
 
3.2.3.15.18. JmsSessionGetTransacted
名称 JmsSessionGetTransacted - Sessionオブジェクトがトランザクションモードであるかどうかを示します。
形式 WOJMSStatus JmsSessionGetTransacted( JmsSession *session, WOJMS_BOOL *value );
説明 sessionで指定したJmsSession構造体に指定されているSessionオブジェクトがトランザクションモードであるかどうかを調べます。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
O value 取得したSessionオブジェクトのトランザクションモードかどうかの値を格納するWOJMS_BOOLへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.getTransacted()
 
3.2.3.15.19. JmsSessionRecover
名称 JmsSessionRecover - Sessionオブジェクト内のメッセージ配信を停止し、もっとも古い未確認応答のメッセージを使用してメッセージ配信を再開します。
形式 WOJMSStatus JmsSessionRecover( JmsSession *session );
説明 sessionで指定したJmsSession構造体に指定されている、Sessionオブジェクト内のメッセージ配信を停止し、もっとも古い未確認応答のメッセージを使用してメッセージ配信を再開します。 すべてのコンシューマが、メッセージを連続した順序で配信します。受信したメッセージを確認応答すると、クライアントに配信済みのメッセージすべてが確認応答されます。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.recover()
 
3.2.3.15.20. JmsSessionRollback
名称 JmsSessionRollback - Sessionオブジェクトのトランザクションで実行されたメッセージをロールバックします。
形式 WOJMSStatus JmsSessionRollback( JmsSession *session );
説明 sessionで指定したJmsSession構造体に指定されている、Sessionオブジェクトのトランザクションで実行されたメッセージをすべてロールバックし、設定中のロックをすべて解放します。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.rollback()
 
3.2.3.15.21. JmsSessionUnsubscribe
名称 JmsSessionUnsubscribe - クライアントにより生成された持続性サブスクリプションを解除します。
形式 WOJMSStatus JmsSessionUnsubscribe( JmsSession *session, JmsString *name );
説明 sessionで指定したJmsSession構造体に指定されている、Sessionオブジェクトから生成された認識名nameを持つ持続性サブスクリプションを解除します。
引数 I/O パラメータ 説明
I session Sessionオブジェクトを指すJmsSession構造体へのポインタを指定します。
I name 持続性サブスクリプションの認識名を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Sessionオブジェクトが無効です。
関連項目 javax.jms.Session.unsubscribe(java.lang.String)

3.2.3.16. StreamMessageインタフェース

StreamMessageインタフェースは、C言語ランタイムライブラリにてJMSのStreamMessageオブジェクトへのインタフェースを提供します。

StreamMessageインタフェースには次の関数があります。

JmsStreamMessageDestroy StreamMessageオブジェクトを破棄します。
JmsStreamMessageReadBoolean StreamMessageオブジェクト内のストリームからboolean型のデータを読み取ります。
JmsStreamMessageReadByte StreamMessageオブジェクト内のストリームから符号付き8ビット値のデータを読み取ります。
JmsStreamMessageReadBytes StreamMessageオブジェクト内のストリームからbyte配列データを読み取ります。
JmsStreamMessageReadChar StreamMessageオブジェクト内のストリームからUnicode文字値を読み取ります。
JmsStreamMessageReadDouble StreamMessageオブジェクト内のストリームからdouble型のデータを読み取ります。
JmsStreamMessageReadFloat StreamMessageオブジェクト内のストリームからfloat型のデータを読み取ります。
JmsStreamMessageReadInt StreamMessageオブジェクト内のストリームから符号付き32ビット整数のデータを読み取ります。
JmsStreamMessageReadLong StreamMessageオブジェクト内のストリームから符号付き64ビット整数のデータを読み取ります。
JmsStreamMessageReadObject StreamMessageオブジェクト内のストリームからjavaオブジェクト型のデータを読み取ります。
JmsStreamMessageReadShort StreamMessageオブジェクト内のストリームから符号付き16ビット数のデータを読み取ります。
JmsStreamMessageReadString StreamMessageオブジェクト内のストリームからUnicode文字列型のデータを読み取ります。
JmsStreamMessageReset StreamMessageオブジェクトのメッセージ本文を読取り専用モードで配置してからストリームを先頭に再配置します。
JmsStreamMessageWriteBoolean StreamMessageオブジェクト内のストリームに、booleanを1バイト値として書き込みます。
JmsStreamMessageWriteByte StreamMessageオブジェクト内のストリームに、byteを1バイト値として書き込みます。
JmsStreamMessageWriteBytes StreamMessageオブジェクト内のストリームに、バイト配列を書き込みます。
JmsStreamMessageWriteChar StreamMessageオブジェクト内のストリームに、Unicode文字値を書き込みます。
JmsStreamMessageWriteDouble StreamMessageオブジェクト内のストリームに、doubleを8バイト値として書き込みます。
JmsStreamMessageWriteFloat StreamMessageオブジェクト内のストリームに、floatを4バイト値として書き込みます。
JmsStreamMessageWriteInt StreamMessageオブジェクト内のストリームに、intを4バイト値として書き込みます。
JmsStreamMessageWriteLong StreamMessageオブジェクト内のストリームに、longを8バイト値として書き込みます。
JmsStreamMessageWriteObject StreamMessageオブジェクト内のストリームに、javaオブジェクトを書き込みます。
JmsStreamMessageWriteShort StreamMessageオブジェクト内のストリームに、shortを2バイト値として書き込みます。
JmsStreamMessageWriteString StreamMessageオブジェクト内のストリームに、文字列を書き込みます。

 
3.2.3.16.1. JmsStreamMessageDestroy
名称 JmsStreamMessageDestroy - StreamMessageオブジェクトを破棄します。
形式 WOJMSStatus JmsStreamMessageDestroy( JmsStreamMessage *message );
説明 messageで指定したJmsStreamMessage構造体に指定されているStreamMessageオブジェクトを破棄します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.16.2. JmsStreamMessageReadBoolean
名称 JmsStreamMessageReadBoolean - StreamMessageオブジェクト内のストリームからboolean型のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadBoolean( JmsStreamMessage *message, WOJMS_BOOL *value );
説明 messageで指定したJmsStreamMessage構造体からboolean値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったboolean値を格納するWOJMS_BOOLへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readBoolean()
 
3.2.3.16.3. JmsStreamMessageReadByte
名称 JmsStreamMessageReadByte - StreamMessageオブジェクト内のストリームから符号付き8ビット値のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadByte( JmsStreamMessage *message, WOJMS_BYTE *value );
説明 messageで指定したJmsStreamMessage構造体からbyte値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったbyte値を格納するWOJMS_BYTEへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readByte()
 
3.2.3.16.4. JmsStreamMessageReadBytes
名称 JmsStreamMessageReadBytes - StreamMessageオブジェクト内のストリームからbyte配列データを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadBytes( JmsStreamMessage *message, WOJMS_BYTES *value, WOJMS_INT *length );
説明 messageで指定したJmsStreamMessage構造体から読取ったbyte配列値を引数valueに、byte配列長を引数lengthに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったbyte配列を格納するWOJMS_BYTESへのポインタを指定します。
O length 読取ったbyte配列長を格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readBytes(byte[])
 
3.2.3.16.5. JmsStreamMessageReadChar
名称 JmsStreamMessageReadChar - StreamMessageオブジェクト内のストリームからUnicode文字値を読み取ります。
形式 WOJMSStatus JmsStreamMessageReadChar( JmsStreamMessage *message, WOJMS_CHAR *value );
説明 messageで指定したJmsStreamMessage構造体からUnicode値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったUnicode値を格納するWOJMS_CHARへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readChar()
 
3.2.3.16.6. JmsStreamMessageReadDouble
名称 JmsStreamMessageReadDouble - StreamMessageオブジェクト内のストリームからdouble型のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadDouble( JmsStreamMessage *message, WOJMS_DOUBLE *value );
説明 messageで指定したJmsStreamMessage構造体からdouble値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったdouble値を格納するWOJMS_DOUBLEへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readDouble()
 
3.2.3.16.7. JmsStreamMessageReadFloat
名称 JmsStreamMessageReadFloat - StreamMessageオブジェクト内のストリームからfloat型のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadFloat( JmsStreamMessage *message, WOJMS_FLOAT *value );
説明 messageで指定したJmsStreamMessage構造体からfloat値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったfloat値を格納するWOJMS_FLOATへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readFloat()
 
3.2.3.16.8. JmsStreamMessageReadInt
名称 JmsStreamMessageReadInt - StreamMessageオブジェクト内のストリームから符号付き32ビット整数のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadInt( JmsStreamMessage *message, WOJMS_INT *value );
説明 messageで指定したJmsStreamMessage構造体からint値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったint値を格納するWOJMS_INTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readInt()
 
3.2.3.16.9. JmsStreamMessageReadLong
名称 JmsStreamMessageReadLong - StreamMessageオブジェクト内のストリームから符号付き64ビット整数のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadLong( JmsStreamMessage *message, WOJMS_LONG *value );
説明 messageで指定したJmsStreamMessage構造体からlong値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったlong値を格納するWOJMS_LONGへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readLong()
 
3.2.3.16.10. JmsStreamMessageReadObject
名称 JmsStreamMessageReadObject - StreamMessageオブジェクト内のストリームからjavaオブジェクト型のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadObject( JmsStreamMessage *message, WOJMS_OBJECT *value );
説明 messageで指定したJmsStreamMessage構造体からjavaオブジェクトを読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったjavaオブジェクトを格納するWOJMS_OBJECTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readObject()
 
3.2.3.16.11. JmsStreamMessageReadShort
名称 JmsStreamMessageReadShort - StreamMessageオブジェクト内のストリームから符号付き16ビット数のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadShort( JmsStreamMessage *message, WOJMS_SHORT *value );
説明 messageで指定したJmsStreamMessage構造体からshort値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取ったshort値を格納するWOJMS_SHORTへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readShort()
 
3.2.3.16.12. JmsStreamMessageReadString
名称 JmsStreamMessageReadString - StreamMessageオブジェクト内のストリームからUnicode文字列型のデータを読み取ります。
形式 WOJMSStatus JmsStreamMessageReadString( JmsStreamMessage *message, JmsString *value );
説明 messageで指定したJmsStreamMessage構造体から文字列の値を読取り、引数valueに格納します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
O value 読取った文字列を格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.readString()
 
3.2.3.16.13. JmsStreamMessageReset
名称 JmsStreamMessageReset - StreamMessageオブジェクトのメッセージ本文を読取り専用モードで配置してからストリームを先頭に再配置します。
形式 WOJMSStatus JmsStreamMessageReset( JmsStreamMessage *message );
説明 messageで指定したJmsStreamMessage構造体を読取り専用モードにしてストリームを先頭に再配置します。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.reset()
 
3.2.3.16.14. JmsStreamMessageWriteBoolean
名称 JmsStreamMessageWriteBoolean - StreamMessageオブジェクト内のストリームに、booleanを1バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteBoolean( JmsStreamMessage *message, WOJMS_BOOL value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueを1バイトのbooleanとして書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value StreamMessageオブジェクトに書き込むboolean値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeBoolean(boolean)
 
3.2.3.16.15. JmsStreamMessageWriteByte
名称 JmsStreamMessageWriteByte - StreamMessageオブジェクト内のストリームに、byteを1バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteByte( JmsStreamMessage *message, WOJMS_BYTE value );
説明 messageで指定したJmsBytesMessage構造体に、引数valueを1バイトのbyte値として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value StreamMessageオブジェクトに書き込むbyte値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeByte(byte)
 
3.2.3.16.16. JmsStreamMessageWriteBytes
名称 JmsStreamMessageWriteBytes - StreamMessageオブジェクト内のストリームに、バイト配列を書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteBytes( JmsStreamMessage *message, WOJMS_BYTES value, WOJMS_INT length );
説明 messageで指定したJmsStreamMessage構造体に、引数valueをバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_BYTEへのポインタを指定します。
I length 書き込みを行うWOJMS_BYTEの先頭からのバイト長を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeBytes(byte[], int, int)
 
3.2.3.16.17. JmsStreamMessageWriteChar
名称 JmsStreamMessageWriteChar - StreamMessageオブジェクト内のストリームに、Unicode文字を書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteChar( JmsStreamMessage *message, WOJMS_CHAR value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueをUnicode文字値として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_CHARの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeChar(char)
 
3.2.3.16.18. JmsStreamMessageWriteDouble
名称 JmsStreamMessageWriteDouble - StreamMessageオブジェクト内のストリームに、doubleを8バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteDouble( JmsStreamMessage *message, WOJMS_DOUBLE value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueを8バイトdoubleのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_DOUBLEの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeDouble(double)
 
3.2.3.16.19. JmsStreamMessageWriteFloat
名称 JmsStreamMessageWriteFloat - StreamMessageオブジェクト内のストリームに、floatを4バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteFloat( JmsStreamMessage *message, WOJMS_FLOAT value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueを4バイトfloatのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_FLOATの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeFloat(float)
 
3.2.3.16.20. JmsStreamMessageWriteInt
名称 JmsStreamMessageWriteInt - StreamMessageオブジェクト内のストリームに、intを4バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteInt( JmsStreamMessage *message, WOJMS_INT value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueを4バイトint型のバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_INTの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeInt(int)
 
3.2.3.16.21. JmsStreamMessageWriteLong
名称 JmsStreamMessageWriteLong - StreamMessageオブジェクト内のストリームに、longを8バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteLong( JmsStreamMessage *message, WOJMS_LONG value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueを8バイトlongのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_LONGの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeLong(long)
 
3.2.3.16.22. JmsStreamMessageWriteObject
名称 JmsStreamMessageWriteObject - StreamMessageオブジェクト内のストリームに、javaオブジェクトを書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteObject( JmsStreamMessage *message, WOJMS_OBJECT value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueをjavaオブジェクトストリームのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_OBJECT構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeObject(java.lang.Object)
 
3.2.3.16.23. JmsStreamMessageWriteShort
名称 JmsStreamMessageWriteShort - StreamMessageオブジェクト内のストリームに、shortを2バイト値として書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteShort( JmsStreamMessage *message, WOJMS_SHORT value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueを2バイトshortのバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うWOJMS_SHORTの値を指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeShort(short)
 
3.2.3.16.24. JmsStreamMessageWriteString
名称 JmsStreamMessageWriteString - StreamMessageオブジェクト内のストリームに、文字列を書き込みます。
形式 WOJMSStatus JmsStreamMessageWriteString( JmsStreamMessage *message, JmsString *value );
説明 messageで指定したJmsStreamMessage構造体に、引数valueをUTF-8形式でエンコードされた文字列のバイト配列として書き込みます。
引数 I/O パラメータ 説明
I message StreamMessageオブジェクトを指すJmsStreamMessage構造体へのポインタを指定します。
I value 書き込みを行うJmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 StreamMessageオブジェクトが無効です。
関連項目 javax.jms.StreamMessage.writeString(java.lang.String)

3.2.3.17. TextMessageインタフェース

TextMessageインタフェースは、C言語ランタイムライブラリにてJMSのTextMessageオブジェクトへのインタフェースを提供します。

TextMessageインタフェースには次の関数があります。

JmsTextMessageDestroy TextMessageオブジェクトを破棄します
JmsTextMessageGetText メッセージのデータを含む文字列を取得します
JmsTextMessageSetText メッセージのデータを含む文字列を設定します

 
3.2.3.17.1. JmsTextMessageDestroy
名称 JmsTextMessageDestroy - TextMessageオブジェクトを破棄します
形式 WOJMSStatus JmsTextMessageDestroy( JmsTextMessage *message );
説明 messageで指定したJmsTextMessage構造体に指定されているTextMessageオブジェクトを破棄します。
引数 I/O パラメータ 説明
I message TextMessageオブジェクトを指すJmsTextMessage構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.17.2. JmsTextMessageGetText
名称 JmsTextMessageGetText - メッセージのデータを含む文字列を取得します
形式 WOJMSStatus JmsTextMessageGetText( JmsTextMessage *message, JmsString *text );
説明 messageで指定したTextMessageオブジェクトのgetTextメソッドを呼び出し、メッセージのデータを含む文字列を取得します。
引数 I/O パラメータ 説明
I message getTextメソッドを呼び出すTextmessageオブジェクトを指すJmsTextMessage構造体へのポインタを指定します。
O text 受信するメッセージ文字列を受け取るためのJmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 TextMessageオブジェクトが無効です。
関連項目 javax.jms.TextMessage.getText()
 
3.2.3.17.3. JmsTextMessageSetText
名称 JmsTextMessageSetText - メッセージのデータを含む文字列を設定します
形式 WOJMSStatus JmsTextMessageSetText( JmsTextMessage *message, JmsString *text );
説明 messageで指定したTextMessageオブジェクトのsetTextメソッドにtext引数を指定して呼び出し、メッセージのデータを含む文字列を設定します。
引数 I/O パラメータ 説明
I message setTextメソッドを呼び出すTextMessageオブジェクトを指すJmsTextMessage構造体へのポインタを指定します。
I text 送信する文字列が格納されたJmsString構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 TextMessageオブジェクトが無効です。
関連項目 javax.jms.TextMessage.setText(java.lang.String)

3.2.3.18. Topicインタフェース

Topicインタフェースは、C言語ランタイムライブラリにてJMSのTopicオブジェクトへのインタフェースを提供します。

Topicインタフェースには次の関数があります。

JmsTemporaryTopicDelete 一時トピックとして生成されたTopicオブジェクトを破棄します。
JmsTopicDestroy Topicオブジェクトを破棄します
JmsTopicGetTopicName Topicオブジェクトから名前を取得します。

 
3.2.3.18.1. JmsTemporaryTopicDelete
名称 JmsTemporaryTopicDelete - 一時トピックとして生成されたTopicオブジェクトを破棄します。
形式 WOJMSStatus JmsTemporaryTopicDelete( JmsTemporaryTopic *topic );
説明 一時トピックである、topicで指定したJmsTemporaryTopic構造体に指定されているTemporaryTopicオブジェクトを破棄します。
引数 I/O パラメータ 説明
I topic TemporaryTopicオブジェクトを指すJmsTemporaryTopic構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 TemporaryTopicオブジェクトが無効です。
関連項目 javax.jms.TemporaryTopic.delete()
 
3.2.3.18.2. JmsTopicDestroy
名称 JmsTopicDestroy - Topicオブジェクトを破棄します
形式 WOJMSStatus JmsTopicDestroy( JmsTopic *topic );
説明 topicで指定したJmsTopic構造体に指定されているTopicオブジェクトを破棄します。
引数 I/O パラメータ 説明
I topic Topicオブジェクトを指すJmsTopic構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
関連項目 -
 
3.2.3.18.3. JmsTopicGetTopicName
名称 JmsTopicGetTopicName - Topicオブジェクトから名前を取得します。
形式 WOJMSStatus JmsTopicGetTopicName( JmsTopic *topic, JmsString *name );
説明 topicで指定したJmsTopic構造体からトピック名を取得し、引数nameに格納します。
引数 I/O パラメータ 説明
I topic Topicオブジェクトを指すJmsTopic構造体へのポインタを指定します。
O name 取得したトピック名を格納するJmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 Topicオブジェクトが無効です。
関連項目 javax.jms.Topic.getTopicName()

3.2.3.19. TopicSubscriberインタフェース

TopicSubscriberインタフェースは、C言語ランタイムライブラリにてJMSのTopicSubscriberオブジェクトへのインタフェースを提供します。

TopicSubscriberインタフェースには次の関数があります。

JmsTopicSubscriberGetNoLocal TopicSubscriberオブジェクトの NoLocal 属性を取得します。
JmsTopicSubscriberGetTopic TopicSubscriberオブジェクトに関連付けられたトピックを取得します。

 
3.2.3.19.1. JmsTopicSubscriberGetNoLocal
名称 JmsTopicSubscriberGetNoLocal - TopicSubscriberオブジェクトの NoLocal 属性を取得します。
形式 WOJMSStatus JmsTopicSubscriberGetNoLocal( JmsTopicSubscriber *subscriber, WOJMS_BOOL *noLocal );
説明 subscriberで指定したJmsTopicSubscriberオブジェクトから NoLocal 属性を取得し、引数NoLocalに格納します。
引数 I/O パラメータ 説明
I subscriber geNoLocalメソッドを呼び出すTopicSubscriberオブジェクトを指す、JmsTopicSubscriber構造体へのポインタを取得します。
O noLocal 取得した NoLocal 属性を格納するWOJMS_BOOLへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 TopicSubscriberオブジェクトが無効です。
関連項目 javax.jms.TopicSubscriber.getNoLocal()
 
3.2.3.19.2. JmsTopicSubscriberGetTopic
名称 JmsTopicSubscriberGetTopic - TopicSubscriberオブジェクトに関連付けられたトピックを取得します。
形式 WOJMSStatus JmsTopicSubscriberGetTopic( JmsTopicSubscriber *subscriber, JmsTopic *topic );
説明 subscriberで指定したJmsTopicSubscriberオブジェクトに関連付けされたトピックを取得し、引数topicに格納します。
引数 I/O パラメータ 説明
I subscriber getTopicメソッドを呼び出すTopicSubscriberオブジェクトを指す、JmsTopicSubscriber構造体へのポインタを取得します。
O topic 取得したトピックを格納するJmsTopic構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 TopicSubscriberオブジェクトが無効です。
関連項目 javax.jms.TopicSubscriber.getTopic()