CiSetAttribute(3dmi)

CiSetAttribute -- set the value of a specified attribute

Synopsis

#include <dmi2ci.h>

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

Description

This function is called to set the specified attribute with the given value. 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 in the specified row should be set. If there is no key list, then the attribute in the first row should be set.

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: (Input) Attribute value to set

Return values

DMIERR_NO_ERROR
DMIERR_OUT_OF_MEMORY
DMIERR_SP_INACTIVE
DMIERR_ATTRIBUTE_NOT_FOUND
DMIERR_VALUE_EXCEEDS_MAXSIZE
DMIERR_COMPONENT_NOT_FOUND
DMIERR_GROUP_NOT_FOUND
DMIERR_ILLEGAL_KEYS
DMIERR_ILLEGAL_TO_SET
DMIERR_ROW_NOT_FOUND
DMIERR_ATTRIBUTE_NOT_SUPPORTED

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.