Imported Upstream version 0.3.9upstream/0.3.9upstream

1 files changed, 98 insertions, 0 deletions

diff --git a/man/man3/Tspi_Context_GetKeyByUUID.3 b/man/man3/Tspi_Context_GetKeyByUUID.3
new file mode 100644
index 0000000..c68c22e
--- /dev/null
+++ b/man/man3/Tspi_Context_GetKeyByUUID.3
@@ -0,0 +1,98 @@
+.\" Copyright (C) 2004 International Business Machines Corporation
+.\" Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
+.\"
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "Tspi_Context_GetKeyByUUID" 3 "2004-05-25" "TSS 1.1"
+.ce 1
+TCG Software Stack Developers Reference
+.SH NAME
+Tspi_Context_GetKeyByUUID \- get a handle to a key registered in persistent storage.
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.nf
+.B #include <tss/platform.h>
+.B #include <tss/tcpa_defines.h>
+.B #include <tss/tcpa_typedef.h>
+.B #include <tss/tcpa_struct.h>
+.B #include <tss/tss_typedef.h>
+.B #include <tss/tss_structs.h>
+.B #include <tss/tspi.h>
+.sp
+.BI "TSS_RESULT Tspi_Context_GetKeyByUUID(TSS_HCONTEXT " hContext ", TSS_FLAG  " persistentStorageType ","
+.BI "                                     TSS_UUID     " uuidData ", TSS_HKEY* " phKey ");"
+.fi
+.sp
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_Context_GetKeyByUUID\fR searches the Persistent Storage database for a registered key using the
+given UUID. It then creates a key object initialized to the found data and
+returns a handle to the key object.
+
+.SH "PARAMETERS"
+.PP
+.SS hContext
+The \fIhContext\fR parameter is the handle of the context object.
+.SS persistentStorageType
+The \fIpersistentStorageType\fR parameter indicates the persistent
+storage the key is registered in.
+.SS uuidData
+The \fIuuidData\fR parameter is the UUID by which the key is registered in
+persistent storage.
+.SS phKey
+The \fIphKey\fR parameter receives the handle of the key object representing
+the key.
+
+.SH "RETURN CODES"
+.PP
+\fBTspi_Context_GetKeyByUUID\fR returns TSS_SUCCESS on success,
+otherwise one of the following values is returned:
+.TP
+.SM TSS_E_INVALID_HANDLE
+\fIhContext\fR is an invalid handle.
+
+.TP
+.SM TSS_E_PS_KEY_NOTFOUND
+The key cannot be found in the persistent storage database.
+
+.TP
+.SM TSS_E_INTERNAL_ERROR
+An internal SW error has been detected.
+
+.TP
+.SM TSS_E_BAD_PARAMETER
+One or more parameters is bad.
+
+.SH "CONFORMING TO"
+
+.PP
+\fBTspi_Context_GetKeyByUUID\fR conforms to the Trusted Computing Group
+Software Specification version 1.1 Golden
+
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_Context_GetTpmObject\fR(3), \fBTspi_Context_LoadKeyByUUID\fR(3),
+\fBTspi_Context_GetRegisteredKeysByUUID\fR(3),
+\fBTspi_Context_GetKeyByPublicInfo\fR(3).
+