Tbsip_Cancel_Commands function (tbs.h)

Cancels all outstanding commands for the specified context.

Syntax

TBS_RESULT Tbsip_Cancel_Commands(
  [in] TBS_HCONTEXT hContext
);

Parameters

[in] hContext

A TBS handle to the context whose commands are to be canceled and that was obtained from previous call to the Tbsi_Context_Create function.

Return value

If the function succeeds, the function returns TBS_SUCCESS.

If the function fails, it returns a TBS return code that indicates the error.

Return code/value Description
TBS_SUCCESS
0 (0x0)
The function was successful.
TBS_E_INTERNAL_ERROR
2150121473 (0x80284001)
An internal software error occurred.
TBS_E_INVALID_CONTEXT
2150121476 (0x80284004)
The specified context handle does not refer to a valid context.
TBS_E_IOERROR
2150121478 (0x80284006)
An error occurred while communicating with the TPM.

Remarks

When a command is canceled, TBS sends a message to the command that indicates that the command was canceled.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header tbs.h
Library Tbs.lib
DLL Tbs.dll