hw_api::object
属性の情報を取得する
&reftitle.description;
hw_api_objecthw_api::object
arrayparameter
この関数は、いずれかのバージョンのオブジェクトの属性情報を取得します。
文書の内容は返しません。
&reftitle.parameters;
parameter
パラメータの配列には、必須要素
'objectIdentifier'、そしてオプションの要素
'attributeSelector' および 'version' が含まれます。
&reftitle.returnvalues;
返されるオブジェクトは、
成功した場合に HW_API_Object、
エラーが発生した場合に HW_API_Error
となります。
&reftitle.examples;
この単純な例では、オブジェクトを取得してエラーが発生したかどうかを調べます。
オブジェクトの取得
reason(0);
echo "Type: ";
switch ($reason->type()) {
case 0:
echo "Error";
break;
case 1:
echo "Warning";
break;
case 2:
echo "Message";
break;
}
echo "
\n";
echo "Description: " . $reason->description("en") . "
\n";
}
function list_attr($obj)
{
echo "\n";
$count = $obj->count();
for ($i=0; $i<$count; $i++) {
$attr = $obj->attribute($i);
printf("| %s | %s |
\n",
$attr->key(), $attr->value());
}
echo "
\n";
}
$hwapi = hwapi_hgcsp($g_config[HOSTNAME]);
$parms = array("objectIdentifier"=>"rootcollection", "attributeSelector"=>array("Title", "Name", "DocumentType"));
$root = $hwapi->object($parms);
if (get_class($root) == "HW_API_Error") {
handle_error($root);
exit;
}
list_attr($root);
?>
]]>
&reftitle.seealso;