Tbsip_Context_Close function

Closes a context handle, which releases resources associated with the context in TBS and closes the binding handle used to communicate with TBS.

Syntax


TBS_RESULT Tbsip_Context_Close(
  _In_  TBS_HCONTEXT hContext
);

Parameters

hContext [in]

A handle of the context to be closed.

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/valueDescription
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.

 

Remarks

When the context handle is closed, the structure associated with the context handle is zeroed, which ensures that subsequent attempts to use the handle will result in an error.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Tbs.h

Library

Tbs.lib

DLL

Tbs.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.