summaryrefslogtreecommitdiff
path: root/man/man3/Tspi_Key_LoadKey.3
diff options
context:
space:
mode:
authorIgor Pashev <pashev.igor@gmail.com>2012-11-25 14:36:20 +0000
committerIgor Pashev <pashev.igor@gmail.com>2012-11-25 14:36:20 +0000
commitc3649a2def02c41d837ae1f79dda729ccb91e677 (patch)
treebea46dff212fdef977fe9094a70a939e8cc21885 /man/man3/Tspi_Key_LoadKey.3
downloadtrousers-c3649a2def02c41d837ae1f79dda729ccb91e677.tar.gz
Imported Upstream version 0.3.9upstream/0.3.9upstream
Diffstat (limited to 'man/man3/Tspi_Key_LoadKey.3')
-rw-r--r--man/man3/Tspi_Key_LoadKey.383
1 files changed, 83 insertions, 0 deletions
diff --git a/man/man3/Tspi_Key_LoadKey.3 b/man/man3/Tspi_Key_LoadKey.3
new file mode 100644
index 0000000..00541f2
--- /dev/null
+++ b/man/man3/Tspi_Key_LoadKey.3
@@ -0,0 +1,83 @@
+.\" Copyright (C) 2005 International Business Machines Corporation
+.\" Written by Kent Yoder 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_Key_LoadKey" 3 "2005-02-01" "TSS 1.1"
+.ce 1
+TCG Software Stack Developer's Reference
+.SH NAME
+Tspi_Key_LoadKey \- load a key into the TPM
+.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_Key_LoadKey(TSS_HKEY " hKey ", TSS_HKEY " hUnwrappingKey ");"
+.fi
+.sp
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_Key_LoadKey\fR loads the key referenced
+by \fIhKey\fR into the TPM.
+
+.SH "PARAMETERS"
+.PP
+.SS hKey
+The \fIhKey\fR parameter is the handle of the key object to load.
+.SS hUnwrappingKey
+The \fIhUnwrappingKey\fR parameter is the handle of the key which should be used to unwrap the key addressed by \fIhKey\fR.
+
+.SH "RETURN CODES"
+.PP
+\fBTspi_Key_LoadKey\fR returns TSS_SUCCESS on success, otherwise
+one of the following values is returned:
+.TP
+.SM TSS_E_INVALID_HANDLE
+Either \fIhKey\fR or \fIhUnwrappingKey\fR is not a valid handle.
+
+.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_Key_LoadKey\fR conforms to the Trusted Computing Group Software
+Specification version 1.1 Golden
+
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_Key_UnloadKey\fR(3), \fBTspi_Key_GetPubKey\fR(3).
+