HP Open Source Security for OpenVMS Volume 1: Common Data Security Architecture > Human Recognition Service (HRS) API Functions

HRS_SetPowerMode

 » Table of Contents

 » Glossary

 » Index

NAME

CSSM_HRS_SetPowerMode, HRS_SetPowerMode — Sets the device to the requested power mode

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_SetPowerMode
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_POWER_MODE PowerMode);

SPI

CSSM_RETURN CSSMHRI HRS_SetPowerMode
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_POWER_MODE PowerMode);

LIBRARY

HRS Extensible Module Manager (cdsa$inhrsemm_shr.exe)

PARAMETERS

The parameter definitions are the same for the API and the SPI.

ModuleHandle (input) 

The handle of the attached HRS service provider.

PowerMode (input)  

A 32-bit value indicting the power mode to which to set the device.

DESCRIPTION

This function sets the device to the requested power mode if the device supports it.

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.

CSSMERR_HRS_FUNCTION_NOT_SUPPORTED