CiGetAttribute(3dmi)

CiGetAttribute -- get value(s) of attribute(s) within a single group

Synopsis

#include <dmi2ci.h>

DmiErrorStatus_t DMI_API CiGetAttribute ( DmiId_t componentId, DmiId_t groupId, DmiId_t attributeId, DmiString_t* language, DmiAttributeValues_t* keyList, DmiAttributeData_t** data);

Description

This function gets value(s) of an individual attribute or multiple attributes within a single group. Although the DmiGetAttributes command from the MI allows gets across multiple groups, the service provider must serialize calls across groups at the component interface level.

This function returns a pointer to a DmiAttributeData_t object that contains the ID, type, and pointer to value for the requested attribute. The component ID, group ID, and attribute ID are passed in as parameters.

If the given group is not a table, then keyList will be a NULL pointer. If the group is a table a keyList may or may not be given. If it is provided, then the attribute value from the requested row should be returned. If there is no key list, then the attribute value from the first row should be returned.

Parameters

componentId: (Input) Component ID containing group
groupId: (Input) Group ID containing attribute
attributeId: (Input) Attribute ID to get
language: (Input) language-code | territory-code | encoding for return data
keyList: (Input) List of row keys
data: (Output) Attribute value returned

Return values

DMIERR_NO_ERROR
DMIERR_OUT_OF_MEMORY
DMIERR_INSUFFICIENT_PRIVILEGES
DMIERR_ATTRIBUTE_NOT_FOUND
DMIERR_COMPONENT_NOT_FOUND
DMIERR_GROUP_NOT_FOUND
DMIERR_ILLEGAL_KEYS
DMIERR_ILLEGAL_TO_GET
DMIERR_ROW_NOT_FOUND
DMIERR_ATTRIBUTE_NOT_SUPPORTED
DMIERR_VALUE_UNKNOWN

For a description of return values, see ``DMI error codes'' in Desktop Management Interface programming.

Notices

Portions of this page are derived from material for which the copyright owner is the Desktop Management Task Force. The material is reprinted with permission. See copyright page for a full statement of rights and permissions.