← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/man3/Tspi_SetAttribData.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_SetAttribData.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_SetAttribData" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
 
23
.SH NAME
 
24
Tspi_SetAttribData \- set a non 32bit attribute of an object.
 
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_SetAttribData(TSS_HOBJECT " hObject ", TSS_FLAG " attribFlag ","
 
38
.BI "                              TSS_FLAG    " subFlag ", UINT32   " ulAttribDataSize ","
 
39
.BI "                              BYTE*       " rgbAttribData ");"
 
40
.fi
 
41
.sp
 
42
.ad
 
43
.hy
 
44
 
 
45
.SH "DESCRIPTION"
 
46
.PP
 
47
\fBTspi_SetAttribData\fR  sets the attributes associated with a given class of object that aren't UINT32. The structure and size of hte attribute data depends on the attribute.
 
48
.SH "PARAMETERS"
 
49
.PP
 
50
.SS hObject
 
51
Handle of the object where the attribute is to be set.
 
52
.PP
 
53
.SS attribFlag
 
54
Flag indicating the attribute to set.
 
55
.PP
 
56
.SS subFlag
 
57
Sub flag indicating the attribute to set
 
58
.PP
 
59
.SS ulAttribDataSize
 
60
Supplies the length (in bytes) of the rgbAttribData.
 
61
.PP
 
62
.SS rgbAttribData
 
63
Pointer to the actual data which is to be set for the specified attribute.
 
64
.SH "RETURN CODES"
 
65
.PP
 
66
\fBTspi_SetAttribData\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
 
67
.TP
 
68
.SM TSS_E_INVALID_HANDLE - \fIhObject\fR is an invalid parameter.
 
69
.TP
 
70
.SM TSS_E_ATTRIB_FLAG - \fIattribFlag\fR is an invalid parameter.
 
71
.TP
 
72
.SM TSS_E_ATTRIB_SUBFLAG - \fIsubFlag\fR is an invalid parameter.
 
73
.TP
 
74
.SM TSS_E_ATTRIB_DATA - \fIrgbAttribData\fR is an invalid parameter.
 
75
.TP
 
76
.SM TSS_E_BAD_PARAMETER
 
77
.TP
 
78
.SM TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.
 
79
 
 
80
.SH "CONFORMING TO"
 
81
 
 
82
.PP
 
83
\fBTspi_SetAttribData\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
 
84
.SH "SEE ALSO"
 
85
 
 
86
.PP
 
87
\fBTspi_GetAttribData\fR(3).