HP OpenVMS Systems Documentation

Content starts here
HP Open Source Security for OpenVMS Volume 1: Common Data Security Architecture > CDSA API Functions

MDSUTIL_GetModuleInfo

  Table of Contents

  Glossary

  Index

NAME

MDSUTIL_GetModuleInfo — Gets information from the MDS registry for the add-in module.

SYNOPSIS

# include <mds_util_api.h> 
# include <mds_util_helper.h>
CSSM_RETURN CSSMAPI MDSUTIL_GetModuleInfo
(const CSSM_GUID *ModuleGUID,
CSSM_SERVICE_MASK UsageMask,
uint32 SubserviceID,
CSSM_USEE_TAG USEERequest,
MDSUTIL_MODULE_INFO_PTR *pModuleInfo)

LIBRARY

Module Directory Services library (cdsa$mds300_shr.exe)

PARAMETERS

ModuleGUID (input)
  

A pointer to the CSSM_GUID structure containing the Globally Unique ID of the add-in module.

UsageMask (input)
  

A bit mask specifying the module usage types used to restrict the capabilities information returned by this function. An input value of zero specifies all usages for the specified module.

SubserviceID (input)
  

A single subservice ID. Note that the operation may already be limited by a service mask. If so, the subservice ID applies to all service categories selected by the service mask.

USEERequest (input)
  

United States Export Exemption tag; should be set to CSSM_USEE_NONE.

pModuleInfo (output)
  

A pointer to the module information.

DESCRIPTION

This function gets a list of descriptive information from the MDS registry for the add-in module identified by the ModuleGUID. The information returned can include all of the capability information for each of the subservices for each of the service types implemented by the selected module. The request for information can be limited to a particular set of services, as specified by the UsageMask. The request may be further limited to one or all of the subservices implemented in one or all of the service categories. The MDSUTIL_FreeModuleInfo function must be called to deallocate memory containing the list.

RETURN VALUE

NULL — Error in retrieving information from the MDS registry.

Not NULL — A pointer to a module info structure containing a pointer to an array of zero or more service information structures. Each structure contains type information identifying the service description as representing certificate library services, data storage library services, and so on. The service descriptions are sub-classed into subservice descriptions that describe the attributes and capabilities of a subservice.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSSM_INVALID_POINTER
CSSMERR_CSSM_INVALID_GUID
CSSM_INVALID_SUBSERVICEID
CSSMERR_CSSM_MEMORY_ERROR
CSSMERR_CSSM_NOT_INITIALIZED
CSSM_ERRCODE_MDS_ERROR

SEE ALSO

Books

Intel CDSA Application Developer's Guide

Online Help

Functions: MDSUTIL_ModuleInstall, MDSUTIL_ModuleUninstall, MDSUTIL_ListModules, MDSUTIL_GetCredLocationFromGUID, MDSUTIL_FreeModuleInfo, MDSUTIL_FreeModuleList, MDSUTIL_ListModuleManagers, MDSUTIL_GetModuleManagerInfo, MDSUTIL_ModuleManagerInstall, MDSUTIL_ModuleManagerUninstall, MDSUTIL_Init, MDSUTIL_Term