CloseListenSessionEx function
The CloseListenSessionEx function will shutdown a ListenSession and optionally remove the ListenSession from the settings.Syntax
int __stdcall CloseListenSessionEx(
__in ProtocolSession *psess,
__in ListenSession *lsess,
__in int flags
);
Parameters
psess [in] A pointer to a ProtocolSession structure. This is a session assigned to a protocol at the moment it's loaded into the memory.
lsess [in] A pointer to a ListenSession structure. This is a session assigned to a plugin at the moment a user defines a new connection.
flags [in] This parameter can be zero or a combination of the following values.
| Value | Meaning |
CLS_REMOVE_LISTENSESSION_FROM_SETTINGS
0x1 | The ListenSession will be removed from the settings. This means next time TV's server starts the ListenSession will not be recovered.
|
Return value
If no error occurs the function returns True (one). If the function fails it will return False (zero).
Remarks
This function will make a call to the function
PrepareCloseListenSession from the Receiver protocol in
lsess. This function should make the
StartListening function return false. Next
CloseClientSession will be called for every
Clientsession(s) associated with
lsess. Last the
ListenSession will be closed by calling
CloseListenSession function exported by all the protocols in the
ListenSession. This functions should remove every recource previously allocated by the
BindToProtocolCallBack function.
When flag CLS_REMOVE_LISTENSESSION_FROM_SETTINGS is set, the
ListenSession wil be removed from the settings, this means the next time TV's server starts the
ListenSession will not be recovered.
Requirements
| Should be exported by | -
|
| Minimum supported API | 1.01
|
| Header | tvsserver_base.h
|