Stop the server, terminating all active client sessions and releasing the
resources that were allocated for the server.
Parameters
None.
Return Value
If the method succeeds, the return value is non-zero. If the
method fails, it will return a value of zero.
Remarks
The Stop method instructs the server to stop
accepting client connections, disconnects all active client
connections and terminates the thread that is managing the server
session. The handle is no longer valid after the server has been
stopped and should no longer be used. Note that it is possible that
the actual handle value may be re-used at a later point when a new
server is started. An application should always consider the server
handle to be opaque and never depend on it being a specific value.
If an application calls this method from within an event handler,
the active client session (the client for which the event handler was
invoked) may not get a disconnect notification. It is recommended that
this method only be called by the same thread that created the
server using the Start method.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csftsv10.lib
See Also
Restart,
Start
|