DmiListGroups(3dmi)

Synopsis

#include <dmi2srv.h>

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

Description

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

The maxCount, requestMode, and groupId parameters allow the caller to control the information returned by the DMI Service Provider. When the requestMode is DMI_UNIQUE, groupId specifies the first group requested (or only group if maxCount is one). When the requestMode is DMI_NEXT, groupId specifies the group just before the one requested. When requestMode is DMI_FIRST, groupId 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 groups, subject to the constraints imposed by requestMode and groupId.

Parameters

handle

(Input) An open session handle

requestMode

(Input) Unique, first, or next group

maxCount

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

getPragma

(Input) Get optional pragma string ?

getDescription

(Input) Get optional group description ?

compId

(Input) Component to access

groupId

(Input) Group to start with (see requestMode)

reply

(Output) List of groups

Return values

DMIERR_NO_ERROR

DMIERR_ILLEGAL_HANDLE

DMIERR_OUT_OF_MEMORY

DMIERR_INSUFFICIENT_PRIVILEGES

DMIERR_SP_INACTIVE

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