Section 3(cbl) - COBOL Functions

ATMI COBOL Function Reference

TPKEYCLOSE(3cbl)

Name

TPKEYCLOSE() - close a previously opened key handle

Synopsis

01 TPKEYDEF-REC.
   COPY TPKEYDEF.

01 TPSTATUS-REC. 
   COPY TPSTATUS.

CALL "TPKEYCLOSE" USING TPKEYDEF-REC TPSTATUS-REC.

Description

TPKEYCLOSE() releases a previously opened key handle and all resources associated with it. Any sensitive information, such as the principal's private key, is erased from memory.

The calling process must supply KEY-HANDLE in TPKEYDEF-REC. KEY-HANDLE is a key identifier returned by a previous call to TPKEYOPEN().

Return Values

Upon successful completion, TPKEYCLOSE() sets TP-STATUS in TPSTATUS-REC to [TPOK].

Errors

Upon failure, TPKEYCLOSE() sets TP-STATUS in TPSTATUS-REC to one of the following values.

[TPEINVAL]

Invalid arguments were given. For example, KEY-HANDLE in TPKEYDEF-REC is not set correctly.

[TPESYSTEM]

An error occurred. Consult the system error log file for details.