blob: b1f1433b1007a059438a664c56dd1ea813085ee0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
.\" Copyright (C) 2004 International Business Machines Corporation
.\" Written by Kathy Robertson 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_GetAttribData" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
.SH NAME
Tspi_GetAttribData \- get a non 32bit attribute of the 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_GetAttribData(TSS_HOBJECT " hObject ", TSS_FLAG " attribFlag ","
.BI " TSS_FLAG " subFlag ", UINT32* " pulAttribDataSize ","
.BI " BYTE** " prgbAttribData ");"
.fi
.sp
.ad
.hy
.SH "DESCRIPTION"
.PP
\fBTspi_GetAttribData\fR is used to get the value of a particular attribute associated iwth a particular object where that attribute does not happen to be a UINT32. The structure and size of the attribute data depends on the attribute.
.SH "PARAMETERS"
.PP
.SS hObject
Handle of the object where to retrieve the attribute.
.PP
.SS attribFlag
Flag indicating the attribute to query.
.PP
.SS subFlag
Sub flag indicating the attribute to query.
.PP
.SS pulAttribDataSize
Recieves the length (in bytes) of the prgbAttribData parameter.
.PP
.SS prgbAttribData
On successful completion of the command, this parameter points to a buffer containing the actual data of the specified attribute.
.SH "RETURN CODES"
.PP
\fBTspi_GetAttribData\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
.TP
.SM TSS_E_INVALID_HANDLE - Either \fIhObject\fR, \fIattribFlag\fR, or \fIsubFlag\fR are invalid.
.TP
.SM TSS_E_ATTRIB_FLAG
.TP
.SM TSS_E_ATTRIB_SUBFLAG
.TP
.SM TSS_E_ATTRIB_DATA
.TP
.SM TSS_E_BAD_PARAMETER
.TP
.SM TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.
.SH "CONFORMING TO"
.PP
\fBTspi_GetAttribData\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
.SH "SEE ALSO"
.PP
\fBTspi_SetAttribData\fR(3).
|
