Share via


CheckUserOption

Applies to: Lync 2013 | Lync Server 2013

CheckUserOption

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, it is false.

Return values

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

See also

Concepts

MSPL built-in functions

MSPL scripting reference