Content-type: text/html Man page of DmiGetConfig

DmiGetConfig

Section: DMI Library Functions (3DMI)
Updated: 17 Dec 1996
Index Return to Main Contents
 

NAME

DmiGetConfig, DmiGetVersion, DmiRegister, DmiSetConfig, DmiUnregister - Management Interface initialization functions  

SYNOPSIS

cc [ flag ... ] file ... -ldmimi -ldmi -lnsl -lrwtool [ library ... ]
#include <server.h>
#include <miapi.h>

bool_t DmiGetConfig(DmiGetConfigIN argin, DmiGetConfigOUT *result, DmiRpcHandle *dmi_rpc_handle);

bool_t DmiGetVersion(DmiGetVersionIN argin, DmiGetVersionOUT *result, DmiRpcHandle *dmi_rpc_handle);

bool_t DmiRegister(DmiRegisterIN argin, DmiRegisterOUT *result, DmiRpcHandle *dmi_rpc_handle);

bool_t DmiSetConfig(DmiSetConfigIN argin, DmiSetConfigOUT *result, DmiRpcHandle *dmi_rpc_handle);

bool_t DmiUnregister(DmiUnregisterIN argin, DmiUnregisterOUT *result, DmiRpcHandle *dmi_rpc_handle);  

DESCRIPTION

The Management Interface initialization functions enable you to register management applications to the Service Provider. You may also retrieve information about the Service Provider, get and set
 session configuration information for your session.

The DmiGetConfig() function retrieves the per-session configuration information. The configuration information consists of a string describing the current language being used for the session. The argin parameter is an instance of a DmiGetConfigIN structure containing the following member:


DmiHandle_t        handle;          /* an open session handle */

The result parameter is a pointer to a DmiGetConfigOUT structure containing the following members:


DmiErrorStatus_t   error_status;
DmiString_t        *language;       /* current session language */

The DmiGetVersion() function retrieves information about the Service Provider. The management application uses the DmiGetVersion() procedure to determine the DMI specification level supported by the Service Provider. This procedure also returns the service provided description string, and may contain version information about the Service Provider implementation. The argin parameter is an instance of a DmiGetVersionIN structure containing the following member:


DmiHandle_t        handle;          /* an open session handle */

The result parameter is a pointer to a DmiGetVersionOUT structure containing the following members:


DmiErrorStatus_t   error_status;
DmiString_t        *dmiSpecLevel;   /* DMI specification version */
DmiString_t        *description;    /* OS specific DMI SP version */
DmiFileTypeList_t  *fileTypes;      /* file types for MIF installation */

The DmiRegister() function provides the management application with a unique per-session handle. The Service Provider uses this procedure to initialize to an internal state for
 subsequent procedure calls made by the application.  This procedure must be the first command executed by the management application. argin is an instance of a DmiRegisterIN structure containing the following member:


DmiHandle_t        handle;          /* an open session handle */

The result parameter is a pointer to a DmiRegisterOUT structure containing the following members:


DmiErrorStatus_t   error_status;
DmiHandle_t        *handle;         /* an open session handle */

The DmiSetConfig() function sets the per-session configuration information. The configuration information consists of a string describing the language required by the management application. The argin parameter is an instance of a DmiSetConfigIN structure containing the following member:


DmiHandle_t        handle;          /* an open session handle */
DmiString_t        *language;       /* current language required */

The result parameter is a pointer to a DmiSetConfigOUT structure containing the following member:


DmiErrorStatus_t   error_status;

The DmiUnregister() function is used by the Service Provider to perform end-of-session cleanup actions. On return from this function, the session handle is no longer valid. This function must be the last DMI command executed by the management application. The argin parameter is an instance of a DmiUnregisterIN structure containing the following member:


DmiHandle_t        handle;          /* an open session handle */

The result parameter is a pointer to a DmiUnregisterOUT structure containing the following members:


DmiErrorStatus_t   error_status;   

 

RETURN VALUES

The DmiGetConfig() function returns the following possible values:

DMIERR_NO_ERROR
DMIERR_ILLEGAL_RPC_HANDLE
DMIERR_OUT_OF_MEMORY
DMIERR_ILLEGAL_PARAMETER
DMIERR_SP_INACTIVE

The DmiGetVersion() function returns the following possible values:

DMIERR_NO_ERROR
DMIERR_ILLEGAL_RPC_HANDLE
DMIERR_OUT_OF_MEMORY
DMIERR_SP_INACTIVE

The DmiRegister() function returns the following possible values:

DMIERR_NO_ERROR
DMIERR_ILLEGAL_RPC_HANDLE
DMIERR_OUT_OF_MEMORY
DMIERR_SP_INACTIVE

The DmiSetConfig() function returns the following possible values:

DMIERR_NO_ERROR
DMIERR_ILLEGAL_RPC_HANDLE
DMIERR_OUT_OF_MEMORY
DMIERR_ILLEGAL_PARAMETER
DMIERR_SP_INACTIVE
DMIERR_ILLEGAL_TO_SET

The DmiUnRegister() function returns the following possible values:

DMIERR_NO_ERROR
DMIERR_ILLEGAL_RPC_HANDLE
DMIERR_OUT_OF_MEMORY
DMIERR_ILLEGAL_PARAMETER
DMIERR_SP_INACTIVE

 

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-levelUnsafe

 

SEE ALSO

attributes(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:13 GMT, October 02, 2010