マップ・メッセージとは、本体が名前と値のペアで構成されるメッセージです。それぞれの値に、関連付けられたデータ型があります。
アプリケーションが名前と値のペアの値を取得するとき、値は XMS によって別のデータ型に変換される可能性があります。この形式の暗黙の型変換について詳しくは、マップ・メッセージを参照してください。
関数 | 説明 |
---|---|
xmsMapMsgGetBoolean | マップ・メッセージの本体から名前で識別されるブール値を取得します。 |
xmsMapMsgGetByte | マップ・メッセージの本体から名前で識別されるバイトを取得します。 |
xmsMapMsgGetBytes | マップ・メッセージの本体から名前で識別されるバイトの配列を取得します。 |
xmsMapMsgGetBytesByRef | マップ・メッセージの本体でのバイトの配列へのポインターを取得し、配列の長さを取得します。 |
xmsMapMsgGetChar | マップ・メッセージの本体から名前で識別される文字を取得します。 |
xmsMapMsgGetDouble | マップ・メッセージの本体から名前で識別される倍精度浮動小数点数を取得します。 |
xmsMapMsgGetFloat | マップ・メッセージの本体から名前で識別される浮動小数点数を取得します。 |
xmsMapMsgGetInt | マップ・メッセージの本体から名前で識別される整数を取得します。 |
xmsMapMsgGetLong | マップ・メッセージの本体から名前で識別される長整数を取得します。 |
xmsMapMsgGetMap | マップ・メッセージの本体の名前と値のペアのリストを取得します。 |
xmsMapMsgGetObject | マップ・メッセージの本体から、名前と値のペアの値と、そのデータ型を取得します。 |
xmsMapMsgGetShort | マップ・メッセージの本体から名前で識別される短整数を取得します。 |
xmsMapMsgGetString | マップ・メッセージの本体から名前で識別されるストリングを取得します。 |
xmsMapMsgGetStringByRef | 名前で識別されるストリングへのポインターを取得し、ストリングの長さを取得します。 |
xmsMapMsgItemExists | マップ・メッセージの本体に、指定した名前が付けられた名前と値のペアが含まれているかどうかをチェックします。 |
xmsMapMsgSetBoolean | マップ・メッセージの本体にブール値を設定します。 |
xmsMapMsgSetByte | マップ・メッセージの本体にバイトを設定します。 |
xmsMapMsgSetBytes | マップ・メッセージの本体にバイトの配列を設定します。 |
xmsMapMsgSetChar | マップ・メッセージの本体に 2 バイト文字を設定します。 |
xmsMapMsgSetDouble | マップ・メッセージの本体に倍精度浮動小数点数を設定します。 |
xmsMapMsgSetFloat | マップ・メッセージの本体に浮動小数点数を設定します。 |
xmsMapMsgSetInt | マップ・メッセージの本体に整数を設定します。 |
xmsMapMsgSetLong | マップ・メッセージの本体に長整数を設定します。 |
xmsMapMsgSetObject | マップ・メッセージの本体に、指定されたデータ型の値を設定します。 |
xmsMapMsgSetShort | マップ・メッセージの本体に短整数を設定します。 |
xmsMapMsgSetString | マップ・メッセージの本体にストリングを設定します。 |
xmsRC xmsMapMsgGetBoolean(xmsHMsg message, xmsCHAR *name, xmsBOOL *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別されるブール値を取得します。
xmsRC xmsMapMsgGetByte(xmsHMsg message, xmsCHAR *name, xmsSBYTE *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別されるバイトを取得します。
xmsRC xmsMapMsgGetBytes(xmsHMsg message, xmsCHAR *name, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別されるバイトの配列を取得します。
この関数の使用方法について詳しくは、値によりバイト配列を戻す C 関数を参照してください。
xmsRC xmsMapMsgGetBytesByRef(xmsHMsg message, xmsCHAR *name, xmsSBYTE **array, xmsINT *length, xmsHErrorBlock errorBlock);
マップ・メッセージの本体でのバイトの配列へのポインターを取得し、配列の長さを取得します。バイトの配列は、名前で識別されます。
この関数の使用方法について詳しくは、参照によりストリングまたはバイト配列を戻す C 関数を参照してください。
xmsRC xmsMapMsgGetChar(xmsHMsg message, xmsCHAR *name, xmsCHAR16 *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別される文字を取得します。
xmsRC xmsMapMsgGetDouble(xmsHMsg message, xmsCHAR *name, xmsDOUBLE *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別される倍精度浮動小数点数を取得します。
xmsRC xmsMapMsgGetFloat(xmsHMsg message, xmsCHAR *name, xmsFLOAT *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別される浮動小数点数を取得します。
xmsRC xmsMapMsgGetInt(xmsHMsg message, xmsCHAR *name, xmsINT *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別される整数を取得します。
xmsRC xmsMapMsgGetLong(xmsHMsg message, xmsCHAR *name, xmsLONG *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別される長整数を取得します。
xmsRC xmsMapMsgGetMap(xmsHMsg message, xmsHIterator *iterator, xmsHErrorBlock errorBlock);
マップ・メッセージの本体の名前と値のペアのリストを取得します。
この関数は、Property オブジェクトのリストをカプセル化するイテレーターを戻します。各 Property オブジェクトは、名前と値のペアをカプセル化しています。アプリケーションは、そのイテレーターを使用して、名前と値のペアのそれぞれに順番にアクセスすることができます。
xmsRC xmsMapMsgGetObject(xmsHMsg message, xmsCHAR *name, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsOBJECT_TYPE *objectType, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から、名前と値のペアの値と、そのデータ型を取得します。名前と値のペアは、名前で識別されます。
この関数の使用方法について詳しくは、値によりバイト配列を戻す C 関数を参照してください。
xmsRC xmsMapMsgGetShort(xmsHMsg message, xmsCHAR *name, xmsSHORT *value, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別される短整数を取得します。
xmsRC xmsMapMsgGetString(xmsHMsg message, xmsCHAR *name, xmsCHAR *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsHErrorBlock errorBlock);
マップ・メッセージの本体から名前で識別されるストリングを取得します。
この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。
xmsRC xmsMapMsgGetStringByRef(xmsHMsg message, xmsCHAR *name, xmsCHAR **string, xmsINT *length, xmsHErrorBlock errorBlock);
名前で識別されるストリングへのポインターを取得し、ストリングの長さを取得します。
この関数の使用方法について詳しくは、参照によりストリングまたはバイト配列を戻す C 関数を参照してください。
xmsRC xmsMapMsgItemExists(xmsHMsg message, xmsCHAR *name, xmsBOOL *pairExists, xmsHErrorBlock errorBlock);
マップ・メッセージの本体に、指定した名前が付けられた名前と値のペアが含まれているかどうかをチェックします。
xmsRC xmsMapMsgSetBoolean(xmsHMsg message, xmsCHAR *name, xmsBOOL value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetByte(xmsHMsg message, xmsCHAR *name, xmsSBYTE value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetBytes(xmsHMsg message, xmsCHAR *name, xmsSBYTE *value, xmsINT length, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetChar(xmsHMsg message, xmsCHAR *name, xmsCHAR16 value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetDouble(xmsHMsg message, xmsCHAR *name, xmsDOUBLE value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetFloat(xmsHMsg message, xmsCHAR *name, xmsFLOAT value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetInt(xmsHMsg message, xmsCHAR *name, xmsINT value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetLong(xmsHMsg message, xmsCHAR *name, xmsLONG value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetObject(xmsHMsg message, xmsCHAR *name, xmsSBYTE *value, xmsINT length, xmsOBJECT_TYPE objectType, xmsHErrorBlock errorBlock);
マップ・メッセージの本体に、指定されたデータ型の値を設定します。
xmsRC xmsMapMsgSetShort(xmsHMsg message, xmsCHAR *name, xmsSHORT value, xmsHErrorBlock errorBlock);
xmsRC xmsMapMsgSetString(xmsHMsg message, xmsCHAR *name, xmsCHAR *value, xmsINT length, xmsHErrorBlock errorBlock);