JevGetFirstExtAttr
機能
JP1イベントの最初に指定されている拡張属性を取得します。
定義ヘッダー
JevApi.h
形式
int JevGetFirstExtAttr(long* lplStatus,
JP1EVENT event,
const char** const lppszName,
const char** const lppszValue);
引数
lplStatus
この関数の異常終了時の状態コードを返す領域へのポインターを指定します。状態コードとその意味は次のとおりです。
|
状態コード |
意味 |
|---|---|
|
JEV_S_PARAM_ERROR |
パラメーターが不正です。 |
|
JEV_S_EXTATTR_EOD |
このJP1イベントにはこれ以上拡張属性は含まれていません。 |
event
JP1イベントアクセス用ハンドル(JevGetEvent()関数の戻り値)を指定します。
lppszName
取得した拡張属性名へのポインターを保存するための領域を示すポインターを指定します。
lppszValue
取得した拡張属性値へのポインターを保存するための領域を示すポインターを指定します。該当するデータがない場合，NULLポインターが設定されます。
戻り値
|
正常終了 |
0を返し，拡張属性名へのポインターをlppszNameで指定された領域に格納する。また，拡張属性値へのポインターをlppszValueで指定された領域に格納する。 |
|
異常終了 |
-1を返す。また，失敗時の詳細エラーコードをlplStatusで指定された領域に格納する。 |