函数原型：

const char* __stdcall AMQCreateConnection1(char* host, int port, const char* factoryName, int* connectionHandle_out);

描述：

该函数用于创建一个到指定地址和端口的 AMQ 服务器的连接，创建的时候指定一个用于创建连接的连接工厂的名称，该连接工厂必须事先在 AMQ 服务器上建立。关于连接和连接工厂的概念，请参考 AMQ 的帮助文档。连接创建完成之后处于 stopped 状态，处于该状态下的连接不能从服务器上接收消息，除非在应用程序中显式的调用 AMQStartConnection 函数，并将该连接的句柄作为参数传递给该函数。使用 AMQCreateConnection1 创建连接的时候将使用匿名登陆的方式登陆服务器，并赋予创建的连接匿名的身份。关于连接身份的用途，请参考 AMQ 的帮助文档。

参数：

host - 要连接的 AMQ 服务器的地址。

port - 要连接的 AMQ 服务器的端口号。

factoryName - 用于创建连接的连接工厂的名称，该名称必须是存在于服务器上的连接工厂的名称。

connectionHandle_out - 连接创建成功之后，用于保存连接的地址的连接句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateConnection2(char* host, int port, const char* factoryName, char* user, char* passwd, int* connectionHandle_out);

描述：

该函数执行与 AMQCreateConnection1 函数相同的功能，但是创建连接的时候使用指定的用户名和密码登陆服务器，并赋予创建的连接该登陆的用户名指定的身份。

参数：

host - 要连接的 AMQ 服务器的地址。

port - 要连接的 AMQ 服务器的端口号。

factoryName - 用于创建连接的连接工厂的名称，该名称必须是存在于服务器上的连接工厂的名称。

user - 用于登陆服务器的用户的用户名。

passwd - 用于登陆服务器的用户的密码。

connectionHandle_out - 连接创建成功之后，用于保存连接的地址的连接句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateConnection3(char* host, int port, int* connectionHandle_out);

描述：

该函数执行与 AMQCreateConnection1 函数相同的功能，但是创建连接的时候使用找到的第一个允许匿名使用的连接工厂创建连接。

参数：

host - 要连接的 AMQ 服务器的地址。

port - 要连接的 AMQ 服务器的端口号。

connectionHandle_out - 连接创建成功之后，用于保存连接的地址的连接句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateConnection4(char* host, int port, char* user, char* passwd, int* connectionHandle_out);

描述：

该函数执行与 AMQCreateConnection3 函数相同的功能，但是创建连接的时候使用指定的用户名和密码登陆服务器，并赋予创建的连接该登陆的用户名指定的身份。

参数：

host - 要连接的 AMQ 服务器的地址。

port - 要连接的 AMQ 服务器的端口号。

user - 用于登陆服务器的用户的用户名。

passwd - 用于登陆服务器的用户的密码。

connectionHandle_out - 连接创建成功之后，用于保存连接的地址的连接句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetConnectionClientID(int connectionHandle, const char** clientId_out);

描述：

获取该连接的客户端标识符，返回值是由 AMQ 服务器特别指定的。这个值可以由 ConnectionFactory 对象中的管理员进行预配置，也可以通过调用 AMQSSetConnectionClientID 方法动态地赋值。

参数：

connectionHandle - 用于获取connectionClientID的连接的句柄。

clientId_out - 获取connectionClientID成功之后，用于保存获取的connectionClientID的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetConnectionClientID(int connectionHandle, const char* clientId);

描述：

为连接设置客户端标识符。指定 AMQ 服务器的客户端标识符的比较好的办法是，在客户端的 ConnectionFactory 对象中进行预配置。关于设置客户端标识符的用途，请参考 AMQ 的帮助文档。

参数：

connectionHandle - 用于设置connectionClientID的连接的句柄。

clientId - 一个唯一的client标识符。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateSession(int connectionHandle, int transacted, int acknowledgeMode, int* sessionHandle_out);

描述：

创建一个 Session 对象。

参数：

connectionHandle - 用于创建 Session 的连接的句柄。

transacted - 指定要创建的 Session 是否是事务性的。0 代表非事务性，1代表事务性，其他值非法。

acknowledgeMode - 指定客户端或者消息消费者收到消息后的确认模式，如果Session是事务性的则忽略该参数。当值为1的时候为 AutoAcknowledge、值为2的时候为 ClientAcknowledge、值为3的时候为 DupsOKAcknowledge、值为0的时候为 SessionTransacted。其他参数值非法。关于各种应答模式的作用，请参考 AMQ 的帮助手册。

sessionHandle_out - 创建 Session 成功之后，用于保存创建的 Session 的 Session 句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQStartConnection(int connectionHandle);

描述：

启动（或者重启）连接以进行消息的传递。如果为一个已经处于start状态的连接调用start方法，则调用会被忽略。

参数：

connectionHandle - 用于启动 Connection 的连接的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQStopConnection(int connectionHandle);

描述：

临时地停止一个连接的消息传递。通过使用连接的 start 方法可以重启消息传递。当连接停止时，连接的所有消息接收者的消息接收都会停止：连接线程会转为阻塞状态。关于停止 Connection 的用途，请参考 AMQ 的帮助文档。

参数：

connectionHandle - 用于停止 Connection 的连接的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCloseConnection(int connectionHandle);

描述：

关闭连接。关闭连接会释放连接所占用的系统资源。关闭连接的同时会关闭由连接对象所产生的 sessions, producers,以及 consumers；并会删除所有的临时目的地。关闭连接的方法会阻塞直到该连接所产生的所有的消息消费者的消息接收行为完成为止。如果该连接所创建的 Session 是事务性的，则关闭连接会引起事务回滚。关于关闭 Connection 的用途，请参考 AMQ 的帮助文档。

参数：

connectionHandle - 用于关闭 Connection 的连接的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateMessage(int sessionHandle, int* messageHandle_out);

描述：

创建一个消息对象，该消息对象拥有所有的标准的消息头信息，当一个消息只是使用消息头存储信息的时候可以使用该消息。

参数：

sessionHandle - 用于创建消息的Session的句柄。

messageHandle_out - 消息创建成功之后，用于保存创建的消息的地址的消息句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateTextMessage1(int sessionHandle, int* textMessageHandle_out);

描述：

创建一个文本消息对象，一个文本消息对象即包含消息头又包含消息体，消息体用于存储一个字符串。

参数：

sessionHandle - 用于创建文本消息的Session的句柄。

textMessageHandle_out - 消息创建成功之后，用于保存创建的文本消息的地址的文本消息句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateTextMessage2(int sessionHandle, const char* text, int* textMessageHandle_out);

描述：

创建一个已初始化的文本消息对象，使用 text 参数指定的字符串初始化文本消息对象。

参数：

sessionHandle - 用于创建文本消息的Session的句柄。

text - 用于初始化文本消息的字符串。

textMessageHandle_out - 消息创建成功之后，用于保存创建的文本消息的地址的文本消息句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQIsSessionTransacted(int sessionHandle, int* sessionTransacted_out);

描述：

判断一个Session是否是一个事务性Session。

参数：

sessionHandle - 要进行判断的Session的句柄。

sessionTransacted_out - 保存判断结果的一个32位的整数，当值为1的时候代表该 Session 是一个事务性Session，当值为0的时候代表该 Session 不是一个事务性Session。关于 Session 的事务性，请参考 AMQ 的帮助手册。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetSessionAcknowledgeMode(int sessionHandle, int* sessionAcknowledgeMode_out);

描述：

返回一个 Session 在收取消息时的应答模式，在创建一个 Session 的时候就必须设置其答复模式。假如一个 Session 是一个事务性的 Session，在收取消息的时候将忽略其应答模式的设置。关于 Session 的事务性和应答模式，请参考 AMQ 的帮助手册。

参数：

sessionHandle - 要取得其应答模式的Session的句柄。

sessionAcknowledgeMode_out - 保存Session应答模式的一个32位的整数，当值为1的时候为 AutoAcknowledge、值为2的时候为 ClientAcknowledge、值为3的时候为 DupsOKAcknowledge、值为0的时候为 SessionTransacted。关于各种应答模式的作用，请参考 AMQ 的帮助手册。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCommitSession(int sessionHandle);

描述：

提交当前 Session 的事务，提交所有发送的消息，确认所有接收的消息，并且释放当前 Session 所持有的所有锁。

参数：

sessionHandle - 要进行提交的 Session 的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQRollbackSession(int sessionHandle);

描述：

回滚当前 Session 的事务，丢弃所有已发送和已接收的消息，并且释放当前 Session 所持有的所有锁。

参数：

sessionHandle - 要进行回滚的 Session 的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQRecoverSession(int sessionHandle);

描述：

使当前 Session 停止接收消息，并且从最早的一条未应答的消息开始重新接收。所有消息都是按照顺序被接收的，应答一个消息即意味着应答前面所有已经收到但是没有被应答的消息。

recover 一个 Session，将促使 Session 执行以下动作：

1. 停止当前消息的接收。

2. 标记所有已经收到但是没有被应答的消息为 “redelivered”状态。

3. 从最早的一条未应答的消息开始重新接收消息，重新接收的消息的顺序不一定会按照原先接收时的顺序进行接收。

参数：

sessionHandle - 要进行 recover 的 Session 的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCloseSession(int sessionHandle);

描述：

关闭一个 Session，释放该 Session 申请的所有资源。关闭一个 Session 的时候会同时关闭该 Session 所创建出来的所有消息生产者（Producer）和消息消费者（Consumer）。关闭一个 Session 的时候，关闭动作将会阻塞直到该 Session 所创建出来的所有消息消费者的消息接收动作完成，也即是接收消息的方法返回为止。关闭一个事务性 Session 的时候，将会导致该 Session 的事务回滚。该函数也是 Session 级别的函数唯一能够多线程同时调用的函数。

参数：

sessionHandle - 要进行关闭的 Session 的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateProducer(int sessionHandle, int destinationHandle, int* messageProducerHandle_out);

描述：

创建一个消息生产者，一个消息生产者用于将消息发送到特定的目的地，该目的地即可以是一个队列也可以是一个主题，所以 destinationHandle 参数即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。

参数：

sessionHandle - 用于创建消息生产者的 Session 的句柄。

destinationHandle - 要发送的消息的目的地对象的句柄，该句柄即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。

messageProducerHandle_out - 消息生产者创建成功之后，用于保存创建的消息生产者的地址的消息生产者句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateConsumer1(int sessionHandle, int destinationHandle, int* messageConsumerHandle_out);

描述：

创建一个接收特定目的地的消息的消息消费者，该目的地即可以是一个队列也可以是一个主题，所以 destinationHandle 参数即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。

参数：

sessionHandle - 用于创建消息消费者的 Session 的句柄。

destinationHandle - 用于接收消息的目的地对象的句柄，该句柄即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。

messageConsumerHandle_out - 消息消费者创建成功之后，用于保存创建的消息消费者的地址的消息消费者句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateConsumer2(int sessionHandle, int destinationHandle, const char* messageSelector, int* messageConsumerHandle_out);

描述：

创建一个接收特定目的地的消息的消息消费者，该目的地即可以是一个队列也可以是一个主题，所以 destinationHandle 参数即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。使用该函数创建一个消息消费者的时候，可以指定该消费者的消息选择器，关于消息选择器，请参考 AMQ 的帮助手册。

参数：

sessionHandle - 用于创建消息消费者的 Session 的句柄。

destinationHandle - 用于接收消息的目的地对象的句柄，该句柄即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。

messageSelector - 用于对消息进行选择的字符串表达式，该表达式将根据消息头中的属性，对消息进行选择接收，该表达式使用 SQL92 作为其表达式语法。空字符串或者NULL值将表示该消费者不使用消息选择器。

messageConsumerHandle_out - 消息消费者创建成功之后，用于保存创建的消息消费者的地址的消息消费者句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateConsumer3(int sessionHandle, int destinationHandle, const char* messageSelector, bool noLocal, int* messageConsumerHandle_out);

描述：

创建一个接收特定目的地的消息的消息消费者，该目的地即可以是一个队列也可以是一个主题，所以 destinationHandle 参数即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。使用该函数创建一个消息消费者的时候，可以指定该消费者的消息选择器，关于消息选择器，请参考 AMQ 的帮助手册。函数中的 noLocal 参数用于标识当该消费者接收消息的目的地是一个主题的时候，通过创建该消费者的连接所创建出来的生产者所发布的消息，是否该消费者将会收到。 true 代表将会收到，false 代表将不会收到。该参数默认时为 false。

参数：

sessionHandle - 用于创建消息消费者的 Session 的句柄。

destinationHandle - 用于接收消息的目的地对象的句柄，该句柄即可以是一个 Queue 对象的句柄，也可以是一个 Topic 对象的句柄。

messageSelector - 用于对消息进行选择的字符串表达式，该表达式将根据消息头中的属性，对消息进行选择接收，该表达式使用 SQL92 作为其表达式语法。空字符串或者NULL值将表示该消费者不使用消息选择器。

noLocal - 用于标识当该消费者接收消息的目的地是一个主题的时候，通过创建该消费者的连接所创建出来的生产者所发布的消息，是否该消费者将会收到。 true 代表将会收到，false 代表将不会收到。该参数默认时为 false。

messageConsumerHandle_out - 消息消费者创建成功之后，用于保存创建的消息消费者的地址的消息消费者句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateDurableSubscriber1(int sessionHandle, int topicHandle, const char* name, int* messageConsumerHandle_out);

描述：

创建一个接收特定主题的消息的持久化订阅者。关于持久化订阅者，请参考 AMQ 的帮助手册。每个持久化订阅者都有一个名称进行标识。该名称对于该 Session 所创建出来的所有持久化订阅者来说必须是唯一的。假如创建持久化订阅者的时候，使用的标识名称已经存在了，那么将使用该函数传入的用于初始化持久化订阅者的参数更新原先已经存在的持久化订阅者。

参数：

sessionHandle - 用于创建持久化订阅者的 Session 的句柄。

topicHandle - 用于接收消息的主题对象的句柄。

name - 用于标识持久化订阅者的订阅者名称。

messageConsumerHandle_out - 持久化订阅者创建成功之后，用于保存创建的持久化订阅者的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateDurableSubscriber2(int sessionHandle, int topicHandle, const char* name, const char* messageSelector, bool noLocal, int* messageConsumerHandle_out);

描述：

创建一个接收特定主题的消息的持久化订阅者。关于持久化订阅者，请参考 AMQ 的帮助手册。每个持久化订阅者都有一个名称进行标识。该名称对于该 Session 所创建出来的所有持久化订阅者来说必须是唯一的。假如创建持久化订阅者的时候，使用的标识名称已经存在了，那么将使用该函数传入的用于初始化持久化订阅者的参数更新原先已经存在的持久化订阅者。

使用该函数创建一个持久化订阅者的时候，可以指定该持久化订阅者的消息选择器，关于消息选择器，请参考 AMQ 的帮助手册。函数中的 noLocal 参数用于标识通过创建该持久化订阅者的连接所创建出来的生产者所发布的消息，是否该持久化订阅者将会收到。 true 代表将会收到，false 代表将不会收到。该参数默认时为 false。

参数：

sessionHandle - 用于创建持久化订阅者的 Session 的句柄。

topicHandle - 用于接收消息的主题对象的句柄。

name - 用于标识持久化订阅者的订阅者名称。

messageSelector - 用于对消息进行选择的字符串表达式，该表达式将根据消息头中的属性，对消息进行选择接收，该表达式使用 SQL92 作为其表达式语法。空字符串或者NULL值将表示该消费者不使用消息选择器。

noLocal - 用于标识通过创建该持久化订阅者的连接所创建出来的生产者所发布的消息，是否该持久化订阅者将会收到。 true 代表将会收到，false 代表将不会收到。该参数默认时为 false。

messageConsumerHandle_out - 持久化订阅者创建成功之后，用于保存创建的持久化订阅者的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateQueue(int sessionHandle, const char* queueName, int* queueHandle_out);

描述：

根据队列的名称创建一个队列。关于队列，请参考 AMQ 的帮助手册。例如：

通过下面这种方式创建出来的Queue，代表一个远程 AMQ 服务器上的队列，@符号之前 是队列的名称，@符号之后是服务器路由名。发送消息到该队列时，会将消息路由到@符号之后 指定的服务器，并将消息放进@符号之前指定的队列。

Queue messageQueue = queueSession.createQueue("testQueue@ServerRouterName");

参数：

sessionHandle - 用于创建队列的 Session 的句柄。

queueName - 队列的名称字符串。

queueHandle_out - 队列创建成功之后，用于保存创建的队列的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCreateTopic(int sessionHandle, const char* topicName, int* topicHandle_out);

描述：

根据主题的名称创建一个主题。关于主题，请参考 AMQ 的帮助手册。该名称必须是存在于服务器上的主题的名称。

参数：

sessionHandle - 用于创建主题的 Session 的句柄。

topicName - 主题的名称字符串。

topicHandle_out - 主题创建成功之后，用于保存创建的主题的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQIsMessageProducerDisableMessageID(int messageProducerHandle, int* isDisableMessageID_out);

描述：

判断发送消息时是否为消息产生消息 ID。

参数：

messageProducerHandle - 用于判断发送消息时是否为消息产生消息 ID 的 Producer 的句柄。

isDisableMessageID_out - 用于保存发送消息时是否为消息产生消息 ID 的整型值。0表示不产生，1表示产生。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQIsMessageProducerDisableMessageTimestamp(int messageProducerHandle, int* isDisableMessageTimestamp_out);

描述：

判断发送消息时是否为消息产生 timestamps。

参数：

messageProducerHandle - 用于判断发送消息时是否为消息产生 timestamps 的 Producer 的句柄。

isDisableMessageTimestamp_out - 用于保存发送消息时是否为消息产生 timestamps 的整型值。0表示不产生，1表示产生。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageProducerDeliveryMode(int messageProducerHandle, int* deliveryMode_out);

描述：

取得消息生产者的消息传递模式。

参数：

messageProducerHandle - 用于取得消息生产者的消息传递模式的 Producer 的句柄。

deliveryMode_out - 用于保存消息生产者的消息传递模式的整型值。1代表非持久化（ NonPersistent ）,2代表持久化（ Persistent ）。关于持久化与非持久化的用法，请参考 AMQ 的帮助文档。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageProducerPriority(int messageProducerHandle, int* priority_out);

描述：

取得消息生产者的默认消息传递优先级。

参数：

messageProducerHandle - 用于取得消息生产者的默认消息传递优先级的 Producer 的句柄。

priority_out - 用于保存消息生产者的默认消息传递优先级的整型值。合法值为0-9，默认值为4。更多关于优先级的使用方法，请参考 AMQ 的帮助文档。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageProducerTimeToLive(int messageProducerHandle, int64* timeToLive_out);

描述：

取得一个消息生产者发送一个消息时的默认消息生存时间（以毫秒为单位）。

参数：

messageProducerHandle - 用于取得一个消息生产者发送一个消息时的默认消息生存时间的 Producer 的句柄。

timeToLive_out - 用于保存消息生产者发送一个消息时的默认消息生存时间的64位的整型值。时间单位为毫秒，0为无时间限制。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageProducerDestination(int messageProducerHandle, int* destination_out);

描述：

取得消息生产者发送消息时的目的地。

参数：

messageProducerHandle - 用于取得消息生产者发送消息时的目的地的 Producer 的句柄。

destination_out - 用于保存消息生产者发送消息时的目的地的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageProducerDisableMessageID(int messageProducerHandle, int isDisable);

描述：

设置发送消息时是否为消息产生消息 ID。默认值为产生。更多的关于设置消息 ID 的使用方法，请参考 AMQ 的帮助文档。

参数：

messageProducerHandle - 用于设置发送消息时是否为消息产生消息 ID 的 Producer 的句柄。

isDisable - 指定消息的 ID 是否可用。0表示不可用状态，1表示可用状态。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageProducerDisableMessageTimestamp(int messageProducerHandle, int isDisable);

描述：

设置发送消息时是否为消息产生 timestamps，默认值为产生。更多的关于设置消息 timestamps 的使用方法，请参考 AMQ 的帮助文档。

参数：

messageProducerHandle - 用于设置发送消息时是否为消息产生 timestamps 的 Producer 的句柄。

isDisable - 指定发送消息时是否为消息产生 timestamps。0表示不产生，1表示产生。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageProducerDeliveryMode(int messageProducerHandle, int deliveryMode);

描述：

设置消息生产者的消息传递模式。

参数：

messageProducerHandle - 用于设置消息生产者的消息传递模式的 Producer 的句柄。

deliveryMode - 指定消息生产者的消息传递模式。1代表非持久化（ NonPersistent ）,2代表持久化（ Persistent ）。关于持久化与非持久化的用法，请参考 AMQ 的帮助文档。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageProducerPriority(int messageProducerHandle, int priority);

描述：

设置消息生产者的默认消息传递优先级。

参数：

messageProducerHandle - 用于设置消息生产者的默认消息传递优先级的 Producer 的句柄。

priority - 指定消息生产者的默认消息传递优先级。合法值为0-9，默认值为4。更多关于优先级的使用方法，请参考 AMQ 的帮助文档。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageProducerTimeToLive(int messageProducerHandle, int64 timeToLive);

描述：

设置一个消息生产者发送一个消息时的默认消息生存时间（以毫秒为单位）。默认设置为0。

参数：

messageProducerHandle - 用于设置一个消息生产者发送一个消息时的默认消息生存时间的 Producer 的句柄。

timeToLive - 指定消息生产者发送一个消息时的默认消息生存时间。值为64位的整数。时间单位为毫秒，0为无时间限制。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSendMessage1(int messageProducerHandle, int messageHandle);

描述：

使用消息生产者的默认接收模式，优先级，以及存在时间发送消息。

参数：

messageProducerHandle - 用于发送消息的 Producer 的句柄。

messageHandle - 要发送消息的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSendMessage2(int messageProducerHandle, int messageHandle, int deliveryMode, int priority, int64 timeToLive);

描述：

使用指定的接收模式，优先级，以及存在时间发送消息。

参数：

messageProducerHandle - 用于发送消息的 Producer 的句柄。

messageHandle - 要发送消息的句柄。

deliveryMode - 指定消息的消息传递模式。

priority - 指定消息的消息传递优先级。

timeToLive - 指定消息的生存时间。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSendMessage3(int messageProducerHandle, int destinationHandle, int messageHandle);

描述：

发送消息至一指定地址，并使用消息生产者默认的接收模式，优先级，以及存在时间发送消息。

参数：

messageProducerHandle - 用于发送消息的 Producer 的句柄。

destinationHandle - 用于指定消息发送地址的 Destination 的句柄。

messageHandle - 要发送消息的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSendMessage4(int messageProducerHandle, int destinationHandle, int messageHandle, int deliveryMode, int priority, int64 timeToLive);

描述：

发送消息至一指定地址，并使用指定的接收模式，优先级，以及存在时间发送消息。

参数：

messageProducerHandle - 用于发送消息的 Producer 的句柄。

destinationHandle - 用于指定消息发送地址的 Destination 的句柄。

messageHandle - 要发送消息的句柄。

deliveryMode - 指定消息的消息传递模式。

priority - 指定消息的消息传递优先级。

timeToLive - 指定消息的生存时间。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCloseMessageProducer(int messageProducerHandle);

描述：

关闭消息生产者。在关闭消息生产者时会同时关闭系统分配给其的资源。更多关于关闭消息生产者的使用方法，请参考 AMQ 的帮助文档。

参数：

messageProducerHandle - 用于关闭消息生产者的 Producer 的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageConsumerMessageSelector(int messageConsumerHandle, const char** messageSelector_out);

描述：

得到消息消费者的消息选择表达式的字符串。关于消息选择表达式，请参考 AMQ 的帮助手册。

参数：

messageConsumerHandle - 要得到其消息选择表达式字符串的消息消费者的句柄。

messageSelector_out - 用于保存消息消费者的消息选择表达式的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQReceiveMessage1(int messageConsumerHandle, int* messageHandle_out);

描述：

接收 AMQ 服务器中的下一个消息，调用该函数之后将会一直阻塞，直到收到服务中的下一个消息或者消息消费者被关闭为止。假如创建该消费者的 Session 是一个事务性的 Session，那么调用该函数之后，通过该消费者收到的消息还保存在服务器上，直到事务提交，才将消息从服务器上删除。

参数：

messageConsumerHandle - 用于接收消息的消息消费者的句柄。

messageHandle_out - 用于保存接收到的消息的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQReceiveMessage2(int messageConsumerHandle, int64 timeout, int* messageHandle_out);

描述：

接收 AMQ 服务器中的下一个消息，调用该函数之后将会一直阻塞，直到收到服务中的下一个消息、接收超时或者消息消费者被关闭为止。假如创建该消费者的 Session 是一个事务性的 Session，那么调用该函数之后，通过该消费者收到的消息还保存在服务器上，直到事务提交，才将消息从服务器上删除。假如超时时间设置为 0 或者 -1，将永不超时。

参数：

messageConsumerHandle - 用于接收消息的消息消费者的句柄。

timeout - 超时时间，单位是毫秒。

messageHandle_out - 用于保存接收到的消息的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQReceiveMessageNoWait(int messageConsumerHandle, int* messageHandle_out);

描述：

接收 AMQ 服务器中的下一个消息，该函数调用之后将立即返回。假如接收到消息了 messageHandle_out 参数将不为 0，否则该参数为 0。

参数：

messageConsumerHandle - 用于接收消息的消息消费者的句柄。

messageHandle_out - 用于保存接收到的消息的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQCloseMessageConsumer(int messageConsumerHandle);

描述：

关闭一个消息消费者，释放该消费者所申请的所有资源。关闭一个消费者的时候，关闭动作将会阻塞直到该消费者 的消息接收动作完成，也即是接收消息的方法返回为止。

参数：

messageConsumerHandle - 要关闭的消息消费者的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageID(int messageHandle, const char** messageID_out);

描述：

得到该消息的 MessageID，每个消息都由该消息唯一的 MessageID，用于区别每个消息，MessageID 由发送消息时的消息生产者产生，以“ID:”开头。

参数：

messageHandle - 要获取其属性的消息的句柄。

messageID_out - 用于保存消息的 MessageID 的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageTimestamp(int messageHandle, int64* timestamp_out);

描述：

得到该消息的发送时间戳，消息的发送时间戳由发送消息时的消息生产者产生。

参数：

messageHandle - 要获取其属性的消息的句柄。

timestamp_out - 用于保存消息的发送时间戳的64位整型值，以毫秒为单位。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageCorrelationID(int messageHandle, const char** correlationID_out);

描述：

得到该消息的关联消息ID，关于关联消息ID的用途，请参考 AMQ 的帮助文档。

参数：

messageHandle - 要获取其属性的消息的句柄。

correlationID_out - 用于保存消息的关联消息ID的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageReplyTo(int messageHandle, int* destination_out);

描述：

得到该消息的回复消息应该发往的目的地的句柄。

参数：

messageHandle - 要获取其属性的消息的句柄。

destination_out - 用于保存回复消息应该发往的目的地的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageDestination(int messageHandle, int* destination_out);

描述：

得到该消息的目的地，消息的目的地由发送消息时的消息生产者产生。

参数：

messageHandle - 要获取其属性的消息的句柄。

destination_out - 用于保存消息目的地的地址的句柄，该句柄是一个32位的整数。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageDeliveryMode(int messageHandle, int* deliveryMode_out);

描述：

得到该消息的传递模式。

参数：

messageHandle - 要获取其属性的消息的句柄。

deliveryMode_out - 用于保存消息的传递模式的32位整型值，1 代表 NonPersistent 模式，2 代表 Persistent 模式。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQIsMessageRedelivered(int messageHandle, int* redelivered_out);

描述：

判断该消息是否是被重新接收的。

参数：

messageHandle - 要获取其属性的消息的句柄。

redelivered_out - 用于保存消息是否被重新接收的32位整型值，1 代表被重新接收，0 代表没有被重新接收。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageType(int messageHandle, const char** messageType_out);

描述：

得到该消息的消息类型，该属性由发送消息的应用进行设置，标识消息在业务层面上的类型。

参数：

messageHandle - 要获取其属性的消息的句柄。

messageType_out - 用于保存消息的类型的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageExpiration(int messageHandle, int64* expiration_out);

描述：

得到该消息的消息过期时间，消息的消息过期时间由发送消息时的消息生产者设置。

参数：

messageHandle - 要获取其属性的消息的句柄。

expiration_out - 用于保存消息的消息过期时间的64位整型值，以毫秒为单位。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessagePriority(int messageHandle, int* priority_out);

描述：

得到该消息的传递优先级，消息的传递优先级由发送消息时的消息生产者设置。

参数：

messageHandle - 要获取其属性的消息的句柄。

priority_out - 用于保存消息的传递优先级的32位整型值，合法值为 0 到 9。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageID(int messageHandle, const char* messageID);

描述：

设置该消息的 MessageID，发送消息的应用不应该设置消息的该属性，因为该属性由发送消息的消息生产者产生并设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

messageID - 要设置的消息的 MessageID 的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageTimestamp(int messageHandle, int64 timestamp);

描述：

设置该消息的消息发送时间戳，发送消息的应用不应该设置消息的该属性，因为该属性由发送消息的消息生产者产生并设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

timestamp - 要设置的消息发送时间戳。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageCorrelationID(int messageHandle, const char* correlationID);

描述：

设置该消息的关联消息ID，关于关联消息ID的用途，请参考 AMQ 的帮助文档。

参数：

messageHandle - 要设置其属性的消息的句柄。

correlationID - 要设置的消息关联ID的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageReplyTo(int messageHandle, int destinationHandle);

描述：

设置该消息的回复消息应该发往的目的地的句柄。

参数：

messageHandle - 要设置其属性的消息的句柄。

destinationHandle - 要设置的回复消息目的地的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageDestination(int messageHandle, int destinationHandle);

描述：

设置该消息的目的地，发送消息的应用不应该设置消息的该属性，因为该属性由发送消息的消息生产者产生并设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

destinationHandle - 要设置的消息目的地。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageDeliveryMode(int messageHandle, int deliveryMode);

描述：

设置该消息的传递模式，发送消息的应用不应该设置消息的该属性，因为该属性由发送消息的消息生产者设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

deliveryMode - 要设置的消息传递模式，1 代表 NonPersistent 模式，2 代表 Persistent 模式。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageRedelivered(int messageHandle, int redelivered);

描述：

设置该消息是否是被重新接收了，应用不应该设置消息的该属性，因为该属性由 AMQ 服务器设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

redelivered - 设置消息是否被重新接收了，1 代表被重新接收，0 代表没有被重新接收。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageType(int messageHandle, const char* messageType);

描述：

设置该消息的消息类型，该属性由发送消息的应用进行设置，标识消息在业务层面上的类型。

参数：

messageHandle - 要设置其属性的消息的句柄。

messageType - 要设置的消息类型的字符串。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageExpiration(int messageHandle, int64 expiration);

描述：

设置该消息的消息过期时间，发送消息的应用不应该设置消息的该属性，因为该属性由发送消息的消息生产者设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

expiration - 要设置的消息过期时间的64位整型值，以毫秒为单位。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessagePriority(int messageHandle, int priority);

描述：

设置该消息的传递优先级，发送消息的应用不应该设置消息的该属性，因为该属性由发送消息的消息生产者设置。

参数：

messageHandle - 要设置其属性的消息的句柄。

priority - 要设置的消息传递优先级的32位整型值，合法值为 0 到 9。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageBooleanProperty(int messageHandle, const char* name, int* property_out);

描述：

取得消息的指定名称的布尔值属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的布尔值属性的32位的整型值。有效值为0（false），1（true）。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageByteProperty(int messageHandle, const char* name, byte* property_out);

描述：

取得消息的指定名称的 byte 属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的 byte 属性的 byte 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageSByteProperty(int messageHandle, const char* name, sbyte* property_out);

描述：

取得消息的指定名称的 sbyte 属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的 sbyte 属性的 sbyte 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageInt16Property(int messageHandle, const char* name, short* property_out);

描述：

取得消息的指定名称的16位整数属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的16位整数属性的 short 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageUInt16Property(int messageHandle, const char* name, ushort* property_out);

描述：

取得消息的指定名称的无符号16位整数属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的无符号16位整数属性的无符号short类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageInt32Property(int messageHandle, const char* name, int* property_out);

描述：

取得消息的指定名称的32位整数属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的32位整数属性的32位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageUInt32Property(int messageHandle, const char* name, uint* property_out);

描述：

取得消息的指定名称的无符号32位整数属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的无符号32位整数属性的无符号32位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageInt64Property(int messageHandle, const char* name, int64* property_out);

描述：

取得消息的指定名称的64位整数属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的64位整数属性的64位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageUInt64Property(int messageHandle, const char* name, uint64* property_out);

描述：

取得消息的指定名称的无符号的64位整数属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的无符号的64位整数属性的无符号的64位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageSingleProperty(int messageHandle, const char* name, float* property_out);

描述：

取得消息的指定名称的 float 属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的 float 属性的 float 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageDoubleProperty(int messageHandle, const char* name, double* property_out);

描述：

取得消息的指定名称的 double 属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的 double 属性的 double 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageStringProperty(int messageHandle, const char* name, const char** property_out);

描述：

取得消息的指定名称的字符串类型的属性。

参数：

messageHandle - 要取得其属性的消息的句柄。

name - 要取得的消息的属性名称。

property_out - 用于保存消息的字符串类型属性的 char 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageBooleanProperty(int messageHandle, const char* name, int value);

描述：

设置消息的指定名称的布尔值类型的属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的布尔值属性的32位整型值。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageByteProperty(int messageHandle, const char* name, byte value);

描述：

设置消息的指定名称的 byte 类型的属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的 byte 属性的 byte 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageSByteProperty(int messageHandle, const char* name, sbyte value);

描述：

设置消息的指定名称的 sbyte 类型的属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的 sbyte 属性的 sbyte 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageInt16Property(int messageHandle, const char* name, short value);

描述：

设置消息的指定名称的16位整数属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的16位整数属性的 short 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageUInt16Property(int messageHandle, const char* name, ushort value);

描述：

设置消息的指定名称的无符号16位整数属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的无符号16位整数属性的无符号 short 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageInt32Property(int messageHandle, const char* name, int value);

描述：

设置消息的指定名称的32位整数属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的32位整数属性的32位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageUInt32Property(int messageHandle, const char* name, uint value);

描述：

设置消息的指定名称的无符号32位整数属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的无符号32位整数属性的无符号32位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageInt64Property(int messageHandle, const char* name, int64 value);

描述：

设置消息的指定名称的64位整数属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的64位整数属性的64位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageUInt64Property(int messageHandle, const char* name, uint64 value);

描述：

设置消息的指定名称的无符号64位整数属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的无符号64位整数属性的无符号64位整型类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageSingleProperty(int messageHandle, const char* name, float value);

描述：

设置消息的指定名称的 float 属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的 float 属性的 float 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageDoubleProperty(int messageHandle, const char* name, double value);

描述：

设置消息的指定名称的 double 属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的 double 属性的 double 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageStringProperty(int messageHandle, const char* name, const char* value);

描述：

设置消息的指定名称的字符串属性。

参数：

messageHandle - 要设置其属性的消息的句柄。

name - 要设置的消息的属性名称。

value - 要设置的消息的字符串属性的 char 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQClearMessageProperties(int messageHandle);

描述：

清除消息的属性。但是消息头和消息体不会被清除。

参数：

messageHandle - 要清除其属性的消息的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQIsMessagePropertyExists(int messageHandle, const char* name, int* isPropertyExists_out);

描述：

判断指定名称的消息属性是否存在。

参数：

messageHandle - 要进行判断的消息的句柄。

name - 要判断的消息的属性名称

isPropertyExists_out - 用于保存指定名称的消息属性是否存在的整型值。1代表存在，0代表不存在。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQAcknowledgeMessage(int messageHandle);

描述：

应答当前消息，应答的时候同时会将原先已经收取了但是没有应答的消息全部应答。关于消息应答，请参考 AMQ 的帮助手册。

参数：

messageHandle - 要应答的消息的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQClearMessageBody(int messageHandle);

描述：

清除消息体。但是消息头和消息属性不会被清除。

参数：

messageHandle - 要清除其消息体的消息的句柄。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQGetMessageText(int textMessageHandle, const char** text_out);

描述：

取得该 TextMessage 的数据。

参数：

textMessageHandle - 要取得其数据的 TextMessage 的句柄。

text_out - 保存包含该 TextMessage 数据的 char 类型。当 TextMessage 消息的数据为空的时候，该值为 NULL。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQSetMessageText(int textMessageHandle, const char* text);

描述：

设置该 TextMessage 的数据。

参数：

textMessageHandle - 要设置其数据的 TextMessage 的句柄。

text - 要设置的 TextMessage 的数据的 char 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。

函数原型：

const char* __stdcall AMQIsTextMessage(int messageHandle, int* isTextMessage_out);

描述：

判断指定的 Message 是否为 TextMessage 类型。

参数：

messageHandle - 要判断其类型的的 Message 的句柄。

isTextMessage_out - 用于保存指定的 Message 是否为 TextMessage 类型的整型值。1代表是 TextMessage 类型，0代表不是 TextMessage 类型。

返回值：

函数调用成功返回NULL（即是整数0），函数调用失败返回一个字符串，该字符串中包含了失败的原因。