This documentation is archived and is not being maintained.

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The CheckUserOption function indicates whether the user is enabled for a specified option.

Syntax

bool CheckUserOption(
  string or Uri Key,
  UserOption Option,
  bool KeyIsPhone
);

Parameters

Key

The identity of the user. Can be a SIP URI, a user URI in the form user@host, a user URI in the form user@host;user=phone, or a telephone number.

Option

Specifies a user option. For example, Options.UcEnabled.

KeyIsPhone

Optional. The value is true if the Key is a phone; otherwise, false.

Return Values

Returns true if the user is enabled for the option specified by the Option parameter; else false.

Show: