1Tspi_Context_GetKeyByUUID(3)Library Functions ManualTspi_Context_GetKeyByUUID(3)
2
3
4
5                   TCG Software Stack Developers Reference
6

NAME

8       Tspi_Context_GetKeyByUUID - get a handle to a key registered in persis‐
9       tent storage.
10

SYNOPSIS

12       #include <tss/platform.h>
13       #include <tss/tcpa_defines.h>
14       #include <tss/tcpa_typedef.h>
15       #include <tss/tcpa_struct.h>
16       #include <tss/tss_typedef.h>
17       #include <tss/tss_structs.h>
18       #include <tss/tspi.h>
19
20       TSS_RESULT Tspi_Context_GetKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG  persistentStorageType,
21                                            TSS_UUID     uuidData, TSS_HKEY* phKey);
22
23
24

DESCRIPTION

26       Tspi_Context_GetKeyByUUID searches the Persistent Storage database  for
27       a  registered  key  using  the given UUID. It then creates a key object
28       initialized to the found data and returns a handle to the key object.
29
30

PARAMETERS

32   hContext
33       The hContext parameter is the handle of the context object.
34
35   persistentStorageType
36       The persistentStorageType parameter indicates  the  persistent  storage
37       the key is registered in.
38
39   uuidData
40       The  uuidData  parameter  is the UUID by which the key is registered in
41       persistent storage.
42
43   phKey
44       The phKey parameter receives the handle of the key object  representing
45       the key.
46
47

RETURN CODES

49       Tspi_Context_GetKeyByUUID returns TSS_SUCCESS on success, otherwise one
50       of the following values is returned:
51
52       TSS_E_INVALID_HANDLE
53              hContext is an invalid handle.
54
55
56       TSS_E_PS_KEY_NOTFOUND
57              The key cannot be found in the persistent storage database.
58
59
60       TSS_E_INTERNAL_ERROR
61              An internal SW error has been detected.
62
63
64       TSS_E_BAD_PARAMETER
65              One or more parameters is bad.
66
67

CONFORMING TO

69       Tspi_Context_GetKeyByUUID conforms to the Trusted Computing Group Soft‐
70       ware Specification version 1.1 Golden
71
72

SEE ALSO

74       Tspi_Context_GetTpmObject(3),  Tspi_Context_LoadKeyByUUID(3), Tspi_Con‐
75       text_GetRegisteredKeysByUUID(3), Tspi_Context_GetKeyByPublicInfo(3).
76
77
78
79
80TSS 1.1                           2004-05-25      Tspi_Context_GetKeyByUUID(3)
Impressum