MDSUTIL_GetModuleInfo

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

MDSUTIL_GetCredLocationFromGUID

MDSUTIL_GetModuleManagerInfo

MDSUTIL_GetModuleInfo

Library
Description
Errors

Parameters
Return Value
See Also

NAME

MDSUTIL_GetModuleInfo - Gets information from the MDS registry for the add-inmodule.

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 containingthe Globally Unique ID of the add-in module.
`UsageMask` (input)
		A bit mask specifying the module usage types usedto 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 operationmay already be limited by a service mask. If so, the subserviceID applies to all service categories selected by the service mask.
`USEERequest` (input)
		United States Export Exemption tag; should be setto CSSM_USEE_NONE.
`pModuleInfo` (output)
		A pointer to the module information.

DESCRIPTION

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

RETURN VALUE

NULL -- Error in retrieving information from the MDSregistry.

Not NULL -- A pointer to a module info structure containinga pointer to an array of zero or more service information structures.Each structure contains type information identifying the servicedescription as representing certificate library services, data storagelibrary services, and so on. The service descriptions are sub-classedinto subservice descriptions that describe the attributes and capabilitiesof 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