CdbrVariableArray::GetValueメソッド

機能

値の取得

形式

// Boolean型の場合
DmaBoolean GetValue(DmaIndex32 iIndex, pDmaBoolean    pbRetValue)
// ID型の場合
DmaBoolean GetValue(DmaIndex32 iIndex, pDmaId        pRetValue)
// Integer32型の場合
DmaBoolean GetValue(DmaIndex32 iIndex, pDmaInteger32 plRetValue)
// String型の場合
DmaBoolean GetValue(DmaIndex32 iIndex, ppDmaString_T ppRetValue)
// 複合データの場合
DmaBoolean GetValue(DmaIndex32 iIndex, CdbrCompound* pRetValue)

詳細

iIndexに指定した位置の要素の値を取得するメソッドです。指定した要素が存在し,かつ値が設定されていない場合は,戻り値にDMA_UNKNOWNが返ります。

引数

iIndex(入力)

取得する要素の位置を,0~(要素数-1)の値で指定します。範囲外の値を指定した場合はエラーになります。

pbRetValue,pRetValue,plRetValue,ppRetValue(出力)

取得する値を格納する領域のアドレスを指定します。指定した領域の型と要素の型が異なる場合,エラーになります。

String型の場合,使用後にdbrDelete関数によって解放してください。

戻り値

DMA_TRUE  正常終了(設定値あり)

DMA_UNKNOWN 正常終了(設定値なし)

DMA_FALSE  異常終了

戻り値の詳細

なし