← Back to branch summary

~ubuntu-branches/ubuntu/precise/trousers/precise-proposed

« back to all changes in this revision

Viewing changes to man/man3/Tspi_Context_LoadKeyByUUID.3

  • Committer: Bazaar Package Importer
  • Author(s): William Lima
  • Date: 2007-04-18 16:39:38 UTC
  • Revision ID: james.westby@ubuntu.com-20070418163938-opscl2mvvi76jiec
Tags: upstream-0.2.9.1
Import upstream version 0.2.9.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man3/Tspi_Context_LoadKeyByUUID.3
 
1
.\" Copyright (C) 2004 International Business Machines Corporation
 
2
.\" Written by Kathy Robertson based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
 
3
.\"
 
4
.de Sh \" Subsection
 
5
.br
 
6
.if t .Sp
 
7
.ne 5
 
8
.PP
 
9
\fB\\$1\fR
 
10
.PP
 
11
..
 
12
.de Sp \" Vertical space (when we can't use .PP)
 
13
.if t .sp .5v
 
14
.if n .sp
 
15
..
 
16
.de Ip \" List item
 
17
.br
 
18
.ie \\n(.$>=3 .ne \\$3
 
19
.el .ne 3
 
20
.IP "\\$1" \\$2
 
21
..
 
22
.TH "Tspi_Context_LoadKeyByUUID" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
 
23
.SH NAME
 
24
Tspi_Context_LoadKeyByUUID \- load a key that's been registered in persistent storage.
 
25
.SH "SYNOPSIS"
 
26
.ad l
 
27
.hy 0
 
28
.nf
 
29
.B #include <tss/platform.h>
 
30
.B #include <tss/tcpa_defines.h>
 
31
.B #include <tss/tcpa_typedef.h>
 
32
.B #include <tss/tcpa_struct.h>
 
33
.B #include <tss/tss_typedef.h>
 
34
.B #include <tss/tss_structs.h>
 
35
.B #include <tss/tspi.h>
 
36
.sp
 
37
.BI "TSS_RESULT Tspi_Context_LoadKeyByUUID(TSS_HCONTEXT " hContext ", TSS_FLAG  " persistentStorageType ", "
 
38
.BI "                                      TSS_UUID     " uuidData ", TSS_HKEY* " phKey ");"
 
39
.fi
 
40
.sp
 
41
.ad
 
42
.hy
 
43
 
 
44
.SH "DESCRIPTION"
 
45
.PP
 
46
\fBTSS_Context_LoadKeyByUUID\fR  
 
47
creates a key object based on the information got from the manager using the UUID and loads the key into the TPM. The persistent storage provides all information to load the parent keys required to load the key associated with the given UUID.
 
48
.SH "PARAMETERS"
 
49
.PP
 
50
.SS hContext
 
51
The handle of the context object.
 
52
.PP
 
53
.SS persistentStorageType
 
54
Flag indicating the persistent storage the key is registered in. It should be either TSS_PS_TYPE_SYSTEM or TSS_PS_TYPE_USER.
 
55
.PP
 
56
.SS uuidData
 
57
The UUID of the key by which the key was registered in the persistent storage (TSP or connected TCS).
 
58
.PP
 
59
.SS phKey
 
60
Receives the handle of the key object representing the loaded key.
 
61
.SH "RETURN CODES"
 
62
.PP
 
63
\fBTspi_Context_LoadKeyByUUID\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
 
64
.TP
 
65
.SM TSS_E_INVALID_HANDLE - \fIhContext\fR is an invalid handle.
 
66
.TP
 
67
.SM TSS_E_BAD_PARAMETER - \fIpersistentStorageType\fR is invalid.
 
68
.TP
 
69
.SM TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.
 
70
.SH "CONFORMING TO"
 
71
 
 
72
.PP
 
73
\fBTspi_Context_LoadKeyByUUID\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
 
74
.SH "SEE ALSO"
 
75
 
 
76
.PP
 
77
\fBTspi_Context_LoadKeyByBlob(3)\fR, \fBTspi_Key_LoadKey(3)\fR.