summaryrefslogtreecommitdiff
path: root/man/man3/Tspi_SetAttribUint32.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_SetAttribUint32.3
downloadtrousers-upstream/0.3.9.tar.gz
Imported Upstream version 0.3.9upstream/0.3.9upstream
Diffstat (limited to 'man/man3/Tspi_SetAttribUint32.3')
-rw-r--r--man/man3/Tspi_SetAttribUint32.3106
1 files changed, 106 insertions, 0 deletions
diff --git a/man/man3/Tspi_SetAttribUint32.3 b/man/man3/Tspi_SetAttribUint32.3
new file mode 100644
index 0000000..3c8280c
--- /dev/null
+++ b/man/man3/Tspi_SetAttribUint32.3
@@ -0,0 +1,106 @@
+.\" 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_SetAttribUint32" 3 "2004-05-25" "TSS 1.1"
+.ce 1
+TCG Software Stack Developers Reference
+.SH NAME
+Tspi_SetAttribUint32 \- set a 32bit attribute associated with a given class or 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_SetAttribUint32(TSS_HOBJECT " hObject ", TSS_FLAG " attribFlag ","
+.BI " TSS_FLAG " subFlag ", UINT32 " ulAttrib "); "
+.fi
+.sp
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_SetAttribUint32\fR sets a uint32 attribute
+associated with a given class or object. In order to use this
+command, you must first create an object and then find the attributes
+you wish to set.
+
+.SH "PARAMETERS"
+.PP
+.SS hObject
+The \fIhObject\fR parameter is the handle of the object or class
+whose attributes are being set. Note that this is any object handler
+- context, policy, TPM, key, hash, etc.
+.SS attribFlag
+The \fIattribFlag\fR parameter indicates the specific attribute to be set.
+.SS subFlag
+The \fIsubFlag\fR parameter also indicates the specific attribute to be set.
+.SS ulAttrib
+The \fIulAttrib\fR parameter is the value that the specified attribute
+will be set to.
+
+.SH "RETURN CODES"
+.PP
+\fBTspi_SetAttribUint32\fR returns TSS_SUCCESS on success, otherwise
+one of the following values is returned:
+.TP
+.SM TSS_E_INVALID_HANDLE
+\fIhObject\fR is not a valid handle.
+
+.TP
+.SM TSS_E_INVALID_ATTRIB_FLAG
+\fIattribFlag\fR is incorrect.
+
+.TP
+.SM TSS_E_INVALID_ATTRIB_SUBFLAG
+\fIsubFlag\fR is incorrect.
+
+.TP
+.SM TSS_E_INVALID_ATTRIB_DATA
+\fIulAttrib\fR is incorrect.
+
+.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_SetAttribUint32\fR conforms to the Trusted Computing Group
+Software Specification version 1.1 Golden
+
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_GetAttribUint32\fR(3), \fBTspi_SetAttribData\fR(3),
+\fBTspi_GetAttribData\fR(3).
+