summaryrefslogtreecommitdiff
path: root/man/man3/Tspi_Policy_AssignToObject.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/Tspi_Policy_AssignToObject.3')
-rw-r--r--man/man3/Tspi_Policy_AssignToObject.386
1 files changed, 86 insertions, 0 deletions
diff --git a/man/man3/Tspi_Policy_AssignToObject.3 b/man/man3/Tspi_Policy_AssignToObject.3
new file mode 100644
index 0000000..fdf1049
--- /dev/null
+++ b/man/man3/Tspi_Policy_AssignToObject.3
@@ -0,0 +1,86 @@
+.\" 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_Policy_AssignToObject" 3 "2004-05-25" "TSS 1.1"
+.ce 1
+TCG Software Stack Developers Reference
+.SH NAME
+Tspi_Policy_AssignToObject \- assign a policy to an object
+.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_Policy_AssignToObject(TSS_HPOLICY " hPolicy ", TSS_HOBJECT " hObject ");"
+.fi
+.sp
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_Policy_AssignToObject\fR assigns a given object
+to a certain policy. The object then uses its assigned policy to process
+an authorized TPM command. When each new object is initialized, it is
+assigned to the default policy, which is created when a context object
+is created. When an object is assigned to a policy, a reference is added
+to the list of assigned objects stored in the policy, and a reference
+to the policy is stored in the object by internal object functions.
+
+.SH "PARAMETERS"
+.PP
+.SS hPolicy
+The \fIhPolicy\fR parameter is the handle of the policy object to be
+assigned to.
+.SS hObject
+The \fIhObject\fR parameter is the object that will be assigned to
+\fIhPolicy\fR.
+
+.SH "RETURN CODES"
+.PP
+\fBTspi_Policy_AssignToObject\fR returns TSS_SUCCESS on success, otherwise
+one of the following values is returned:
+.TP
+.SM TSS_E_INVALID_HANDLE
+\fIhPolicy\fR is not a valid handle.
+
+.TP
+.SM TSS_E_INTERNAL_ERROR
+An internal SW error has been detected.
+
+.SH "CONFORMING TO"
+
+.PP
+\fBTspi_Policy_AssignToObject\fR conforms to the Trusted Computing Group
+Software Specification version 1.1 Golden
+
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_Policy_SetSecret\fR(3), \fBTspi_Policy_FlushSecret\fR(3).
+