IMapMessage

映射消息是消息主体由一组名称/值对组成的消息,其中每个值都有关联的数据类型。

继承层次结构:
IBM.XMS.IPropertyContext
   |
   +----IBM.XMS.IMessage
           |
           +----IBM.XMS.IMapMessage

当应用程序获取 "名称/值" 对的值时, XMS 可以将该值转换为其他数据类型。 有关此形式的隐式转换的更多信息,请参阅 XMS 消息的主体中有关映射消息的信息。

.NET 个属性

.NET 属性的摘要:
.NET 属性 描述
MapNames 获取映射消息主体中名称的枚举。

MapNames - 获取映射名称

接口:
System.Collections.IEnumerator MapNames
{
  get;
}

获取映射消息主体中名称的枚举。

异常:
  • XMSException

方法

方法汇总:
方法 描述
GetBoolean 从映射消息主体中获取由名称标识的布尔值。
GetByte 从映射消息主体中获取由名称标识的字节。
GetBytes 从映射消息主体中获取由名称标识的字节数组。
GetChar 从映射消息主体中获取由名称标识的字符。
GetDouble 从映射消息主体中获取由名称标识的双精度浮点数。
GetFloat 从映射消息主体中获取由名称标识的浮点数。
GetInt 从映射消息主体中获取由名称标识的整数。
GetLong 从映射消息主体中获取由名称标识的长整数。
GetObject 从映射消息主体中获取对名称/值对中的值的引用。
GetShort 从映射消息主体中获取由名称标识的短整数。
GetString 从映射消息主体中获取由名称标识的字符串。
ItemExists 检查映射消息主体是否包含具有指定名称的名称/值对。
SetBoolean 在映射消息主体中设置布尔值。
SetByte 在映射消息主体中设置单个字节。
SetBytes 在映射消息主体中设置字节数组。
SetChar 在映射消息主体中设置 2 字节字符。
SetDouble 在映射消息主体中设置双精度浮点数。
SetFloat 在映射消息主体中设置浮点数。
SetInt 在映射消息主体中设置整数。
SetLong 在映射消息主体中设置长整数。
SetObject 在映射消息主体中设置必须为 XMS 基本类型的值。
SetShort 在映射消息主体中设置短整数。
SetString 在映射消息主体中设置字符串。

GetBoolean - 获取布尔值

接口:
Boolean GetBoolean(String name);

从映射消息主体中获取由名称标识的布尔值。

参数:
name(输入)
用于封装可标识布尔值的名称的 String 对象。
返回:
从映射消息主体中检索的布尔值。
异常:
  • XMSException

GetByte - 获取单个字节

接口:
Byte    GetByte(String name);
    Int16   GetSignedByte(String name);

从映射消息主体中获取由名称标识的字节。

参数:
name(输入)
用于封装可标识字节的名称的 String 对象。
返回:
从映射消息主体中检索的字节。 将不会对该字节执行任何数据转换。
异常:
  • XMSException

GetBytes - 获取多个字节

接口:
Byte[]  GetBytes(String name);

从映射消息主体中获取由名称标识的字节数组。

参数:
name(输入)
用于封装可标识字节数组的名称的 String 对象。
返回:
数组中的字节数。
异常:
  • XMSException

GetChar - 获取字符

接口:
Char    GetChar(String name);

从映射消息主体中获取由名称标识的字符。

参数:
name(输入)
用于封装可标识字符的名称的 String 对象。
返回:
从映射消息主体中检索的字符。
异常:
  • XMSException

GetDouble - 获取双精度浮点数

接口:
Double  GetDouble(String name);

从映射消息主体中获取由名称标识的双精度浮点数。

参数:
name(输入)
用于封装可标识双精度浮点数的名称的 String 对象。
返回:
从映射消息主体中检索的双精度浮点数。
异常:
  • XMSException

GetFloat - 获取浮点数

接口:
Single  GetFloat(String name);

从映射消息主体中获取由名称标识的浮点数。

参数:
name(输入)
用于封装可标识浮点数的名称的 String 对象。
返回:
从映射消息主体中检索的浮点数。
异常:
  • XMSException

GetInt - 获取整数

接口:
Int32   GetInt(String name);

从映射消息主体中获取由名称标识的整数。

参数:
name(输入)
用于封装可标识整数的名称的 String 对象。
返回:
从映射消息主体中检索的整数。
异常:
  • XMSException

GetLong - 获取长整数

接口:
Int64   GetLong(String name);

从映射消息主体中获取由名称标识的长整数。

参数:
name(输入)
用于封装可标识长整数的名称的 String 对象。
返回:
从映射消息主体中检索的长整数。
异常:
  • XMSException

GetObject - 获取对象

接口:
Object  GetObject(String name);

从映射消息主体中获取对名称/值对中的值的引用。 此名称/值对由名称标识。

参数:
name(输入)
用于封装名称/值对中的名称的 String 对象。
返回:
以下某种对象类型的值:
  • Boolean
  • Byte
  • Byte[]
  • Char
  • Double
  • Single
  • Int32
  • Int64
  • Int16
  • String
异常:
XMSException

GetShort - 获取短整数

接口:
Int16   GetShort(String name);

从映射消息主体中获取由名称标识的短整数。

参数:
name(输入)
用于封装可标识短整数的名称的 String 对象。
返回:
从映射消息主体中检索的短整数。
异常:
  • XMSException

GetString - 获取字符串

接口:
String  GetString(String name);

从映射消息主体中获取由名称标识的字符串。

参数:
name(输入)
用于封装可标识映射消息主体中的字符串的名称的 String 对象。
返回:
用于封装从映射消息主体中检索的字符串的 String 对象。 如果需要进行数据转换,那么该值是转换后的字符串。
异常:
  • XMSException

ItemExists - 检查名称/值对是否存在

接口:
Boolean ItemExists(String name);

检查映射消息主体是否包含具有指定名称的名称/值对。

参数:
name(输入)
用于封装名称/值对中的名称的 String 对象。
返回:
  • True(如果映射消息主体包含具有指定名称的名称/值对)。
  • False(如果映射消息主体不包含具有指定名称的名称/值对)。
异常:
  • XMSException

SetBoolean - 设置布尔值

接口:
void  SetBoolean(String name, Boolean value);

在映射消息主体中设置布尔值。

参数:
name(输入)
用于封装可标识映射消息主体中的布尔值的名称的 String 对象。
value(输入)
要设置的布尔值。
返回:
Void
异常:
  • XMSException

SetByte - 设置单个字节

接口:
void  SetByte(String name, Byte value);
void  SetSignedByte(String name, Int16 value);

在映射消息主体中设置单个字节。

参数:
name(输入)
用于封装可标识映射消息主体中的字节的名称的 String 对象。
value(输入)
要设置的字节。
返回:
Void
异常:
  • XMSException

SetBytes - 设置多个字节

接口:
void  SetBytes(String name, Byte[] value);

在映射消息主体中设置字节数组。

参数:
name(输入)
用于封装可标识映射消息主体中的字节数组的名称的 String 对象。
value(输入)
要设置的字节数组。
返回:
Void
异常:
  • XMSException

SetChar - 设置字符

接口:
void  SetChar(String name, Char value);

在映射消息主体中设置 2 字节字符。

参数:
name(输入)
用于封装可标识映射消息主体中的字符的名称的 String 对象。
value(输入)
要设置的字符。
返回:
Void
异常:
  • XMSException

SetDouble - 设置双精度浮点数

接口:
void  SetDouble(String name, Double value);

在映射消息主体中设置双精度浮点数。

参数:
name(输入)
用于封装可标识映射消息主体中的双精度浮点数的名称的 String 对象。
value(输入)
要设置的双精度浮点数。
返回:
Void
异常:
  • XMSException

SetFloat - 设置浮点数

接口:
void  SetFloat(String name, Single value);

在映射消息主体中设置浮点数。

参数:
name(输入)
用于封装可标识映射消息主体中的浮点数的名称的 String 对象。
value(输入)
要设置的浮点数。
返回:
Void
异常:
  • XMSException

SetInt - 设置整数

接口:
void  SetInt(String name, Int32 value);

在映射消息主体中设置整数。

参数:
name(输入)
用于封装可标识映射消息主体中的整数的名称的 String 对象。
value(输入)
要设置的整数。
返回:
Void
异常:
  • XMSException

SetLong - 设置长整数

接口:
void  SetLong(String name, Int64 value);

在映射消息主体中设置长整数。

参数:
name(输入)
用于封装可标识映射消息主体中的长整数的名称的 String 对象。
value(输入)
要设置的长整数。
返回:
Void
异常:
  • XMSException

SetObject - 设置对象

接口:
void  SetObject(String name, Object value);

在映射消息主体中设置必须为 XMS 基本类型的值。

参数:
name(输入)
用于封装可标识映射消息主体中的值的名称的 String 对象。
value(输入)
包含要设置的值的字节数组。
返回:
Void
异常:
  • XMSException

SetShort - 设置短整数

接口:
void  SetShort(String name, Int16 value);

在映射消息主体中设置短整数。

参数:
name(输入)
用于封装可标识映射消息主体中的短整数的名称的 String 对象。
value(输入)
要设置的短整数。
返回:
Void
异常:
  • XMSException

SetString - 设置字符串

接口:
void  SetString(String name, String value);

在映射消息主体中设置字符串。

参数:
name(输入)
用于封装可标识映射消息主体中的字符串的名称的 String 对象。
value(输入)
用于封装要设置的字符串的 String 对象。
返回:
Void
异常:
  • XMSException

继承的属性和方法