Function prototype
aat_int32 AAL2ProcGetHSMModuleVersionRpl(
aat_byte *InReply,
aat_int32 ReplySize,
aat_ascii *Moduleversion,
aat_int32 *ModuleversionLength);
Description
This function processes a reply from the HSM to a Get HSM Module version code command generated with the AAL2GenGetHSMModuleVersionCmd function.
Parameters
Table: Parameters (AAL2ProcGetHSMModuleVersionRpl) | Type | Name | Use | Description |
|---|
| aat_byte * | InReply | I | Up to 40 bytes that contain the GET HSM MODULEVERSION command type and the output data from the get Module HSM Module Version function on the HSM: - Command type - 2 bytes
- Return code - 4 bytes
- ModuleVersion - up to 16 bytes
- ModuleVersionLength - 4 bytes
Plus 12 bytes for Authentication Suite Server SDK internal use. |
| aat_int32 | ReplySize | I | The length of the InReply message. |
| aat_ascii * | ModuleVersion | O | String of up to 15+1 characters library version of the form w.x.y.z with w, x, y, and z positive decimal value between 0 and 255 (+ 1 null terminator character). |
| aat_int32 * | ModuleVersionLength | I/O | In input, this parameter must indicate the size of the allocated buffer for the ModuleVersion parameter (recommended 16 bytes). In output, this parameter indicates the length of the ModuleVersion string (without the null-terminated character). |
Return codes
Table: Return codes (AAL2ProcGetHSMModuleVersionRpl) | Code | Meaning | Code | Meaning |
|---|
| 0 | Success | 1019 | Missing mandatory TLV item |
| 701 | Invalid input buffer pointer | 1025 | Buffer too small |
| 910 | Invalid HSM command in reply | 1328 | Invalid module version |
| 1009 | Invalid TLV total length | 1329 | Module version buffer too small |
| 1018 | Invalid TLV item pointer | 1330 | Invalid module version length pointer |