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

« back to all changes in this revision

Viewing changes to man/man3/Tspi_Policy_AssignToObject.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:
 
1
.\" Copyright (C) 2004 International Business Machines Corporation
 
2
.\" Written by Megan Schneider 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_Policy_AssignToObject" 3 "2004-05-25" "TSS 1.1"
 
23
.ce 1
 
24
TCG Software Stack Developers Reference
 
25
.SH NAME
 
26
Tspi_Policy_AssignToObject \- assign a policy to an object
 
27
.SH "SYNOPSIS"
 
28
.ad l
 
29
.hy 0
 
30
.nf
 
31
.B #include <tss/platform.h>
 
32
.B #include <tss/tcpa_defines.h>
 
33
.B #include <tss/tcpa_typedef.h>
 
34
.B #include <tss/tcpa_struct.h>
 
35
.B #include <tss/tss_typedef.h>
 
36
.B #include <tss/tss_structs.h>
 
37
.B #include <tss/tspi.h>
 
38
.sp
 
39
.BI "TSS_RESULT Tspi_Policy_AssignToObject(TSS_HPOLICY " hPolicy ", TSS_HOBJECT " hObject ");"
 
40
.fi
 
41
.sp
 
42
.ad
 
43
.hy
 
44
 
 
45
.SH "DESCRIPTION"
 
46
.PP
 
47
\fBTspi_Policy_AssignToObject\fR assigns a given object
 
48
to a certain policy. The object then uses its assigned policy to process
 
49
an authorized TPM command. When each new object is initialized, it is
 
50
assigned to the default policy, which is created when a context object
 
51
is created. When an object is assigned to a policy, a reference is added
 
52
to the list of assigned objects stored in the policy, and a reference
 
53
to the policy is stored in the object by internal object functions.
 
54
 
 
55
.SH "PARAMETERS"
 
56
.PP
 
57
.SS hPolicy
 
58
The \fIhPolicy\fR parameter is the handle of the policy object to be
 
59
assigned to.
 
60
.SS hObject
 
61
The \fIhObject\fR parameter is the object that will be assigned to
 
62
\fIhPolicy\fR.
 
63
 
 
64
.SH "RETURN CODES"
 
65
.PP
 
66
\fBTspi_Policy_AssignToObject\fR returns TSS_SUCCESS on success, otherwise
 
67
one of the following values is returned:
 
68
.TP
 
69
.SM TSS_E_INVALID_HANDLE
 
70
\fIhPolicy\fR is not a valid handle.
 
71
 
 
72
.TP
 
73
.SM TSS_E_INTERNAL_ERROR
 
74
An internal SW error has been detected.
 
75
 
 
76
.SH "CONFORMING TO"
 
77
 
 
78
.PP
 
79
\fBTspi_Policy_AssignToObject\fR conforms to the Trusted Computing Group
 
80
Software Specification version 1.1 Golden
 
81
 
 
82
.SH "SEE ALSO"
 
83
 
 
84
.PP
 
85
\fBTspi_Policy_SetSecret\fR(3), \fBTspi_Policy_FlushSecret\fR(3).
 
86