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

.\" 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_FlushSecret" 3 "2004-05-25" "TSS 1.1"

.ce 1

TCG Software Stack Developers Reference

.SH NAME

Tspi_Policy_FlushSecret \- flush a cached secret

.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_FlushSecret(TSS_HPOLICY " hPolicy ");"

.fi

.sp

.ad

.hy

 

.SH "DESCRIPTION"

.PP

\fBTspi_Policy_FlushSecret\fR 

tells the TSS to flush a secret that it had cached for a user.

 

.SH "PARAMETERS"

.PP

.SS hPolicy

The \fIhPolicy\fR parameter is the handle of the policy object to be flushed.

 

.SH "RETURN CODES"

.PP

\fBTspi_Policy_FlushSecret\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_FlushSecret\fR conforms to the Trusted Computing Group

Software Specification version 1.1 Golden

 

.SH "SEE ALSO"

 

.PP

\fBTspi_Policy_SetSecret\fR(3), \fBTspi_Policy_AssignToObject\fR(3).