1Tspi_Key_UnloadKey(3)      Library Functions Manual      Tspi_Key_UnloadKey(3)
2
3
4
5                   TCG Software Stack Developer's Reference
6

NAME

8       Tspi_Key_UnloadKey - unload a key from the TPM
9

SYNOPSIS

11       #include <tss/platform.h>
12       #include <tss/tcpa_defines.h>
13       #include <tss/tcpa_typedef.h>
14       #include <tss/tcpa_struct.h>
15       #include <tss/tss_typedef.h>
16       #include <tss/tss_structs.h>
17       #include <tss/tspi.h>
18
19       TSS_RESULT Tspi_Key_UnloadKey(TSS_HKEY hKey);
20
21
22

DESCRIPTION

24       Tspi_Key_UnloadKey  unloads  the key referenced by the given key object
25       from the TPM. This call will result in a TPM_EvictKey operation for the
26       specified key.
27
28
29

PARAMETERS

31   hKey
32       The hKey parameter is the handle of the key object to unload.
33
34

RETURN CODES

36       Tspi_Key_UnloadKey returns TSS_SUCCESS on success, otherwise one of the
37       following values is returned:
38
39       TSS_E_INVALID_HANDLE
40              hKey is not a valid handle.
41
42
43       TSS_E_INTERNAL_ERROR
44              An internal SW error has been detected.
45
46
47       TSS_E_BAD_PARAMETER
48              One or more parameters is bad.
49
50

CONFORMING TO

52       Tspi_Key_UnloadKey conforms to the  Trusted  Computing  Group  Software
53       Specification version 1.1 Golden
54
55

SEE ALSO

57       Tspi_Key_LoadKey(3), Tspi_Key_GetPubKey(3).
58
59
60
61
62TSS 1.1                           2004-05-25             Tspi_Key_UnloadKey(3)