Share via


IRTCClient::PrepareForShutdown

The PrepareForShutdown method asynchronously prepares the Client object for shutting down. The user agent is unregistered from registrars, and the active Watchers are unsubscribed. No new sessions can be initiated or accepted after calling this method.

The PrepareForShutdown method may take a number of seconds to return. An RTCE_CLIENT event of type RTCCET_ASYNC_CLEANUP_DONE signals that the method is complete. IRTCClient::Shutdown should not be called until this event is received.

HRESULT PrepareForShutdown();

Parameters

This method has no parameters.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_CLIENT_NOT_INITIALIZED The client has not been initialized.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCClient is defined as 07829e45-9a34-408e-a011-bddf13487cd1.

See Also

IRTCClient, IRTCClient::Shutdown, Shut Down RTC