HP OpenVMS Systems Documentation

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

MDSUTIL_ListModules

 » Table of Contents

 » Glossary

 » Index

NAME

MDSUTIL_ListModules — Returns a list containing the GUID/version/name for each of the currently installed service provider modules that provide services in any of the CSSM functional categories selected in the usage mask. The MDSUTIL_FreeModuleList function must be called to deallocate memory containing the list.

SYNOPSIS

# include <mds_util_api.h> 
# include <mds_util_helper.h>
CSSM_RETURN CSSMAPI MDSUTIL_ListModules 
(CSSM_SERVICE_MASK UsageMask,
CSSM_BOOL MatchAll,
MDSUTIL_LIST_PTR *pList)

LIBRARY

Module Directory Services library (cdsa$mds300_shr.exe)

PARAMETERS

UsageMask (input)
  

A bit mask selecting CSSM functional categories of interest for selecting information about potential service provider modules.

MatchAll (input) 

A Boolean value to indicate if the add-in has to match all of the conditions expressed in UsageMask. TRUE means all conditions must be met. FALSE means one or more conditions must be met.

pList (output) 

Pointer to a list of modules. Each item contains a CSSM_GUID, the module version, and a descriptive string name of the module.

DESCRIPTION

This function returns a list containing the GUID/version/name for each of the currently installed service provider modules that provide services in any of the CSSM functional categories selected in the usage mask. The MDSUTIL_FreeModuleList function must be called to deallocate memory containing the list.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition.The value CSSM_OK indicates success. All other values represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSM_ERRCODE_MDS_ERROR
CSSMERR_CSSM_INVALID_POINTER
CSSM_ERRCODE_INVALID_OUTPUT_POINTER
CSSM_ERRCODE_MEMORY_ERROR
CSSMERR_NOT_INITIALIZED

SEE ALSO

Books

Intel CDSA Application Developer's Guide

Online Help

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