Tbsip_Context_Close function (tbs.h)
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
[in] hContext
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/value | Description |
---|---|
|
The function was successful. |
|
An internal software error occurred. |
|
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. All objects that have been created under this context will be flushed.
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 |