Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_Key_UnloadKey (3)

Name

Tspi_Key_UnloadKey - unload a key from the TPM

Synopsis

#include <tss/platform.h>
#include <tss/tcpa_defines.h>
#include <tss/tcpa_typedef.h>
#include <tss/tcpa_struct.h>
#include <tss/tss_typedef.h>
#include <tss/tss_structs.h>
#include <tss/tspi.h>

TSS_RESULT Tspi_Key_UnloadKey(TSS_HKEY hKey);

Description

Tspi_Key_UnloadKey(3)      Library Functions Manual      Tspi_Key_UnloadKey(3)



                   TCG Software Stack Developer's Reference

NAME
       Tspi_Key_UnloadKey - unload a key from the TPM

SYNOPSIS
       #include <tss/platform.h>
       #include <tss/tcpa_defines.h>
       #include <tss/tcpa_typedef.h>
       #include <tss/tcpa_struct.h>
       #include <tss/tss_typedef.h>
       #include <tss/tss_structs.h>
       #include <tss/tspi.h>

       TSS_RESULT Tspi_Key_UnloadKey(TSS_HKEY hKey);



DESCRIPTION
       Tspi_Key_UnloadKey  unloads  the key referenced by the given key object
       from the TPM. This call will result in a TPM_EvictKey operation for the
       specified key.



PARAMETERS
   hKey
       The hKey parameter is the handle of the key object to unload.


RETURN CODES
       Tspi_Key_UnloadKey returns TSS_SUCCESS on success, otherwise one of the
       following values is returned:

       TSS_E_INVALID_HANDLE
              hKey is not a valid handle.


       TSS_E_INTERNAL_ERROR
              An internal SW error has been detected.


       TSS_E_BAD_PARAMETER
              One or more parameters is bad.


CONFORMING TO
       Tspi_Key_UnloadKey conforms to the  Trusted  Computing  Group  Software
       Specification version 1.1 Golden



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+---------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE       |
       +---------------+---------------------------+
       |Availability   | library/security/trousers |
       +---------------+---------------------------+
       |Stability      | Uncommitted               |
       +---------------+---------------------------+
SEE ALSO
       Tspi_Key_LoadKey(3), Tspi_Key_GetPubKey(3).




NOTES
       This software was built from source available at https://github.com/or-
       acle/solaris-userland.  The original community  source  was  downloaded
       from                                                    https://source-
       forge.net/projects/trousers/files/trousers/0.3.13/trousers-0.3.13.tar.gz

       Further information about this software can be found on the open source
       community website at http://trousers.sourceforge.net/.



TSS 1.1                           2004-05-25             Tspi_Key_UnloadKey(3)