Share via

RTC_REGISTRATION_STATE

  • Article

The RTC_REGISTRATION_STATE enumeration describes the Client registration state. The IRTCProfile::get_State method returns a value of this enumeration.

typedef enum RTC_REGISTRATION_STATE
{
  RTCRS_NOT_REGISTERED, 
  RTCRS_REGISTERING, 
  RTCRS_REGISTERED, 
  RTCRS_REJECTED, 
  RTCRS_UNREGISTERING, 
  RTCRS_ERROR, 
  RTCRS_LOGGED_OFF, 
  RTCRS_LOCAL_PA_LOGGED_OFF, 
  RTCRS_REMOTE_PA_LOGGED_OFF
} RTC_REGISTRATION_STATE;

Constants

  • RTCRS_NOT_REGISTERED
    The profile is not registered. The application called the IRTCClientProvisioning::DisableProfile method and has been successfully deregistered from the server.

  • RTCRS_REGISTERING
    The profile is registering. The application has called IRTCClientProvisioning::EnableProfile or IRTCClientProvisioning2::EnableProfileEx and the SIP REGISTER message has been sent out to the SIP server.

  • RTCRS_REGISTERED
    The profile is registered.

  • RTCRS_REJECTED
    The profile has been rejected. The server has rejected the SIP REGISTER request with a SIP failure response. Some common status codes for this state are:

    • STATUS_CODE_SERVER_TIMEOUT (SIP 504 response): The domain part of the URI is wrong.
    • RTC_E_STATUS_CLIENT_NOT_FOUND (SIP 404 response): The URI is wrong.
    • RTC_E_STATUS_CLIENT_UNAUTHORIZED (SIP 401 response): The account name or password is incorrect.
    • RTC_E_SIP_AUTH_TYPE_NOT_SUPPORTED: The allowedauth property for this profile does not include the authentication type used by the SIP server, or the realm in the authentication challenge does not match the value set for this profile.
    • RTC_E_SIP_DNS_FAIL: No DNS record could be found for the SIP server specified for this profile.

  • RTCRS_UNREGISTERING
    The profile is unregistering. The application called the IRTCClientProvisioning::DisableProfile method and the unregister SIP message has been sent to the SIP server.

  • RTCRS_ERROR
    There has been an error registering the profile.

  • RTCRS_LOGGED_OFF
    The server has removed the registration for this profile. Incoming requests are no longer forwarded. One of the common reasons for this state is the user signing in with the SIP server from another device using the same user URI.

  • RTCRS_LOCAL_PA_LOGGED_OFF
    The server has revoked the status as a presence agent for this user. Incoming presence subscriptions are no longer forwarded and our presence status is no longer visible to others from this client.

  • RTCRS_REMOTE_PA_LOGGED_OFF
    The client that was the presence agent for this user has logged off. It may be possible to register as a presence agent from this client.

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.

See Also

IRTCProfile::get_State, IRTCRegistrationStateChangeEvent::get_State