![]() |
![]() |
|
|
tpkey_getinfo(3c)
Name
tpkey_getinfo()—Gets information associated with a key handle.
Synopsis
#include <atmi.h>
int tpkey_getinfo(TPKEY hKey, char *attribute_name, void *value, long *value_len, long flags)
Description
tpkey_getinfo() reports information about a key handle. A key handle represents a specific principal's key and the information associated with it.
The key under examination is identified by the hKey input parameter. The attribute for which information is desired is identified by the attribute_name input parameter. Some attributes are specific to a cryptographic service provider, but the following core set of attributes should be supported by all providers.
The ASN.1 DER algorithm object identifiers supported by the default public key implementation are given in Table 11.
The information associated with the specified attribute_name parameter will be stored in the memory location indicated by value. The maximum amount of data that can be stored at this location is specified by the caller in value_len.
After tpkey_getinfo() completes, value_len is set to the size of the data actually returned (including a terminating NULL value for string values). If the number of bytes that need to be returned exceeds value_len, tpkey_getinfo() fails (with the TPELIMIT error code) and sets value_len to the required amount of space.
The flags argument is reserved for future use and must be set to 0.
Return Values
On failure, this function returns -1 and sets tperrno() to indicate the error condition.
Errors
See Also
tpkey_close(3c), tpkey_open(3c), tpkey_setinfo(3c)
![]() |
![]() |
![]() |
|
Copyright © 2001 BEA Systems, Inc. All rights reserved.
|