CdbrDMA::GetPropertyValuesメソッド

機能

プロパティの取得

形式

virtual DmaBoolean GetPropertyValues(
 DmaInteger32         lPropDefListCount,
 SDBR_PROPDEF*        pPropDefList,
 SDBR_PROPLIST**      ppPropList )
 
// プロパティ定義情報構造体
struct SDBR_PROPDEF {
   DmaId            PropId;              // プロパティ識別子
};
 
// プロパティ構造体
struct SDBR_PROP {
 DmaId              PropId;              // プロパティ識別子
 DmaInteger32       lType;               // データ型
 DmaInteger32       lCardinality;        // 基本単位
 DmaInteger32       lCount;              // 要素数
 union {                                 // プロパティの値
   pDmaBoolean      pbBoolean;           // Boolean型
   pDmaInteger32    plInteger32;         // Integer32型
   pDmaId           pId;                 // ID型
   pDmapv           ppObject;            // Object型
   ppDmaString_T    ppString;            // String型
 } uniValue;
};

// プロパティリスト構造体
struct SDBR_PROPLIST {
   DmaInteger32      lCount;            // プロパティ情報の個数
   SDBR_PROP*        pItem;             // プロパティ情報
};

詳細

プロパティの値を一括して取得するメソッドです。

次に,プロパティを取得して標準出力に表示する例を示します。

プロパティの値の取得例

SDBR_PROPDEF   PropDef[2];
SDBR_PROPLIST* pPropList = NULL;
SDBR_PROP*     pProp = NULL;
int            i,j;
 
// 取得したいプロパティのIDをリストに設定します。
PropDef[0].PropId = PROPERTY_ID_OF_NUMBER;
PropDef[1].PropId = PROPERTY_ID_OF_AUTHORS;
 
// プロパティの値を取得します。
if (pDbrDMA->GetPropertyValues(2, PropDef, &pPropList)
== DMA_FALSE) {
   return DMA_FALSE;
}
 
// 型を判定して出力します。
for (i = 0; i < pPropList->lCount; i++) {
 pProp = &pPropList->pItem[i];
 if (memcmp(&pProp->PropId,&PROPERTY_ID_OF_NUMBER
   ,sizeof(PROPERTY_ID_OF_NUMBER)) == 0) {
   for(j = 0;j < pProp->lCount;j++) {
     printf("Number=%d¥n", pProp->uniValue.plInteger32[j]);
   }
 }
 else if (memcmp(&pProp->PropId,&PROPERTY_ID_OF_AUTHORS
   ,sizeof(PROPERTY_ID_OF_AUTHORS)) == 0) {
     for(j = 0;j < pProp->lCount;j++) {
       printf("Author=%s¥n", pProp->uniValue.ppString[j]);
     }
 }
}
// メモリの解放
dbrDelete (pPropList);

引数

lPropDefListCount(入力)

pPropDefListに指定した配列の要素数を指定します。負の値を指定した場合は,エラーになります。

pPropDefList(入力)

取得するプロパティの定義情報の配列を,SDBR_PROPDEF構造体として指定します。なお,lPropDefListCountが正の整数のときにpPropDefListにNULLを指定すると,エラーになります。SDBR_PROPDEF構造体の指定内容については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。

ppPropList(出力)

取得したプロパティリスト構造体である,SDBR_PROPLIST構造体へのポインタが設定されます。ポインタを格納する領域を指定してください。*ppPropListがポイントする領域は,ライブラリが新たに確保したものです。この領域はメソッドをコールした側がdbrDelete関数を使用して解放してください。なお,プロパティがまったく取得されなかった場合は,NULLが設定されます。

SDBR_PROPLIST構造体およびSDBR_PROP構造体に設定される内容については,「付録C.1(14) SDBR_PROPLIST構造体(プロパティリスト構造体)」および「付録C.1(12) SDBR_PROP構造体(プロパティ構造体)」を参照してください。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBERR_DB_DEADLOCK_OCCURREDデータベースでデッドロックが発生しました。時間を置いて,再度実行してください。
ERR_DBERR_DB_FAILEDデータベースで障害が発生しました。syslogを参照して,障害の原因を取り除いてください。
ERR_DBERR_DB_LOCKEDオブジェクトがロックされています。時間を置いて,再度実行してください。
ERR_DBRERR_ACCESS_NOT_PERMITTEDアクセス権がありません。この操作は実行できません。
ERR_DBRERR_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_OBJECT_ALREADY_CONNECTEDオブジェクトはすでに接続されています。この操作は実行できません。
ERR_DBRERR_OBJECT_REMOVEDオブジェクトはすでに削除されています。正しいオブジェクトを指定してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_BAD_CLASSID指定された識別子は,利用できるオブジェクトのクラスではありません。正しいクラス識別子を指定してください。
ERR_DMADMARC_BAD_OIIDSetOIIDメソッドで設定されたOIIDが不正です。正しいOIIDを指定してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_PROPIDプロパティの識別子が不正です。正しいプロパティ識別子を指定してください。
ERR_DMADMARC_BAD_VALUEプロパティやリストの値が,許容範囲外の値であるかまたは最大値を超えました。値の範囲を見直してください。
ERR_DMADMARC_DATATYPE_MISMATCHプロパティのデータ型に適切ではないメソッドです。正しい型を指定してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_READ_ONLY読み取り専用のオブジェクトまたはプロパティのため,異常終了しました。このプロパティの値は更新できません。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMADMARC_VALUE_NOT_SET要求されたプロパティは値を保持していません。この操作は実行できません。