TPKEYSETINFO(3cbl)


	Corporate Info \| News \| Solutions \| Products \| Partners \| Services \| Events \| Download \| How To Buy
	http://www.oracle.com/technology/documentation/index.html \| Site Map \| Search \| PDF Files \| Contact \| Glossary

Tuxedo Doc Home \| Reference \| Topic List \| Previous \| Next \| Contents

BEA Tuxedo COBOL Function Reference

TPKEYSETINFO(3cbl)

Name

TPKEYSETINFO() - set optional parameters associated with a key handle

Synopsis

01 TPKEYDEF-REC. 
   COPY TPKEYDEF.

01 TPSTATUS-REC. 
   COPY TPSTATUS.

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

Description

TPKEYSETINFO() sets an optional attribute parameter for a key handle. A key handle represents a specific principal's key and the information associated with it.

The key for which information is to be modified is identified by KEY-HANDLE in TPKEYDEF-REC. KEY-HANDLE is a key identifier returned by a previous call to TPKEYOPEN().

The attribute for which information is to be modified is identified by ATTRIBUTE-NAME in TPKEYDEF-REC. The attribute name may be padded with SPACES or LOW-VALUES. Some attributes may be specific to a certain cryptographic service provider, but the core set of attributes presented on the TPKEYGETINFO(3cbl) reference page should be supported by all providers.

The information to be associated with ATTRIBUTE-NAME is stored in the memory location indicated by ATTRIBUTE-VALUE in TPKEYDEF-REC. If the data content of ATTRIBUTE-VALUE is self-describing, ATTRIBUTE-LEN in TPKEYDEF-REC is ignored (and may be 0). Otherwise, ATTRIBUTE-LEN must contain the length of data in ATTRIBUTE-VALUE.

Return Values

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

Errors

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

[TPEINVAL]: Invalid arguments were given. For example, KEY-HANDLE is not set correctly.
[TPESYSTEM]: An error occurred. Consult the system error log file for more details.
[TPELIMIT]: The attribute value provided is too large.
[TPENOENT]: The requested attribute is not recognized by the key's cryptographic service provider.