AAL2GenGetHSMModuleVersionCmd

  • Published on Jul 9, 2025
  • 1 minute(s) read
Prev Next

Function prototype

aat_int32 AAL2GenGetHSMModuleVersionCmd(
                                        aat_byte     *Cmd,
                                        aat_int32    *CmdSize);

Description

This function creates a command for the HSM to process. It is used to retrieve the version of the current Authentication Suite Server SDK for HSM module (Thales ProtectServer or Entrust nShield).

This function must be used with the post-HSM API AAL2ProcGetHSMModuleVersionRpl.

Parameters

  Table: Parameters (AAL2GenGetHSMModuleVersionCmd)
TypeNameUseDescription
aat_byte *CmdO

Up to 2 bytes that serialize the GET HSM MODULE VERSION command type and the input data to the get Module HSM Module Version function on the HSM:

  • Command Type - 2 bytes
aat_int32 *CmdSizeI/O

On entry, this parameter contains the size of the Cmd buffer.

On exit, this parameter contains the length of the Cmd message.

Return codes

  Table: Return codes (AAL2GenGetHSMModuleVersionCmd)
CodeMeaningCodeMeaning
0Success1025Data buffer too small
590Invalid command pointer