DmiListComponents(3dmi)
DmiListComponents --
list information about installed components
Synopsis
cc [options] file -llibdmionc # remote calls
cc [options] file -llibdmi2api # local calls
#include <dmi2srv.h>
DmiErrorStatus_t DMI_API DmiListComponents (
DmiHandle_t handle,
DmiRequestMode_t requestMode,
DmiUnsigned_t maxCount,
DmiBoolean_t getPragma,
DmiBoolean_t getDescription,
DmiId_t compId,
DmiComponentList_t ** reply );
Description
The DmiListComponents function retrieves the name
and (optionally) the description of
components in a system. This command is used to interrogate a
system to determine what components are installed. An enumeration
can access a specific component or may be used to sequentially
access all components in a system. The caller may choose not to
retrieve the component 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 compId parameters allow the caller
to control the information returned by the DMI Service Provider.
When the requestMode is DMI_UNIQUE, compId specifies the first
component requested (or only component if maxCount is one).
When the requestMode is DMI_NEXT, compId specifies the component
just before the one requested. When requestMode is DMI_FIRSTs,
compId 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
components, subject to the constraints imposed by requestMode
and compId.
Parameters
handle-
(Input)
An open session handle
requestMode-
(Input)
Unique, first, or next
maxCount-
(Input)
Maximum number to return, or 0 for all
getPragma-
(Input)
Get optional pragma string ?
getDescription-
(Input)
Get optional component description ?
compId-
(Input)
Component to start with (see requestMode)
reply-
(Output)
List of components
Return values
DMIERR_NO_ERROR-
DMIERR_ILLEGAL_HANDLE-
DMIERR_OUT_OF_MEMORY-
DMIERR_INSUFFICIENT_PRIVILEGES-
DMIERR_SP_INACTIVE-
DMIERR_COMPONENT_NOT_FOUND-
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
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.
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 25 April 2004