DmiListAttributes(3dmi)

Synopsis

#include <dmi2srv.h>

DmiErrorStatus_t DMI_API DmiListAttributes(
		DmiHandle_t		handle,
		DmiRequestMode_t	requestMode,
		DmiUnsigned_t		maxCount,
		DmiBoolean_t		getPragma,
		DmiBoolean_t		getDescription,
		DmiId_t			compId,
		DmiId_t			groupId,
		DmiId_t			attribId,
		DmiAttributeList_t **	reply );

Description

The caller may choose not to retrieve the description string by setting the value of getDescription to false. Likewise, the caller may choose not to retrieve the pragma string by setting the value of getPragma to false.

The maxCount, requestMode, and attribId parameters allow the caller to control the information returned by the DMI Service Provider. When the requestMode is DMI_UNIQUE, attribId specifies the first attribute requested (or only attribute if maxCount is one). When the requestMode is DMI_NEXT, attribId specifies the attribute just before the one requested. When requestMode is DMI_FIRST, attribId is unused.

To control the amount of information returned, the caller sets maxCount to something other than zero. The Service Provider must honor this limit on the amount of information returned. When maxCount is zero the Service Provider returns information for all attributes, subject to the constraints imposed by requestMode and attribId.

Parameters

handle

(Input) An open session handle

requestMode

(Input) Unique, first, or next attribute

maxCount

(Input) Maximum number to return, or 0 for all

getPragma

(Input) Get optional pragma string ?

getDescription

(Input) Get optional attribute description ?

compId

(Input) Component to access

groupId

(Input) Group to access

attribId

(Input) Attribute to start with (see requestMode)

reply

(Output) List of attributes

Return values

DMIERR_NO_ERROR

DMIERR_ILLEGAL_HANDLE

DMIERR_OUT_OF_MEMORY

DMIERR_INSUFFICIENT_PRIVILEGES

DMIERR_SP_INACTIVE

DMIERR_ATTRIBUTE_NOT_FOUND

DMIERR_COMPONENT_NOT_FOUND

DMIERR_GROUP_NOT_FOUND

DMIERR_NO_PRAGMA

DMIERR_NO_DESCRIPTION

DMIERR_DATABASE_CORRUPT

DMIERR_FILE_ERROR

DMIERR_DEFAULT_LANGUAGE_RETURNED

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

Notices