• About TV's server
  • New in version 3.10
  • About the source code
  • About protocols/plugins
  • TV's server API
  • Protocol Initialisation
  • Protocol binding
  • Protocol Listening and handling
  • Protocol data storage
  • Control panel
  • Multi column list
  • Time and date
  • Http protocol functions
  • Unimplemented and/or replaced functions
  • ControlPanelOption structure

    Contains information about a single secutity-, menu- or user changeable-option.

    Syntax

    typedef struct ControlPanelOption{
    int size;
    int flags;
    char *name;
    char *optionName;
    char *description;
    char *groupName;
    char *iconURL;
    char *bigIconURL;
    char *menuURL;
    struct UserValueOption *userValue;
    } ControlPanelOption;

    Members

    sizeflags
    ValueMeaning
    CPO_PRIV_PROTOCOL_OPTION
    0x1
    Set this flag will make this a valid privilege option for the protocol settings.
    CPO_PRIV_LISTENSESSION_OPTION
    0x2
    Set this flag will make this a valid privilege option for an active connection with a client.
    CPO_PRIV_READABLE
    0x4
    Set this flag will make this privilege option readable. The administrator will be able to grants/prohibits read rights for this option to a certain user.
    CPO_PRIV_WRITEABLE
    0x8
    Set this flag will make this privilege option writeable. The administrator will be able to grants/prohibits write rights for this option to a certain user.

    ValueMeaning
    CPO_SHOW_IN_MENU
    0x10
    Set this flag will make this option be visible as shortcut in the control panel menu.

    ValueMeaning
    CPO_GEN_PROTOCOL_OPTION
    0x20
    Set this flag will make this a valid option for the protocol settings.
    CPO_GEN_LISTENSESSION_OPTION
    0x200
    Set this flag will make this a valid option for an listen session or an active connection with a client.
    CPO_GEN_READONLY
    0x4
    Set this flag will make this option readonly, it cannot be modified by the user.
    CPO_GEN_LISTENSESSION_READONLY
    0x8
    Set this flag will make this option readonly for a running listensession, it cannot be modified by the user when the listensession is started.

    ValueMeaning
    CPO_OPTIONNAME_IS_UNICODE
    0x40
    The name pointed out by member optionName is an unicode string (it's ascii by default).
    GDPD_NAME_IS_INTEGER
    0x80
    The name paramter is not a pointer to a null-terminated string but an integer to identify the data.
    CPO_DESCRIPTION_IS_UNICODE
    0x100
    The description pointed out by member description is an unicode string (it's ascii by default).

    nameoptionNamedescriptiongroupNameiconURLbigIconURLmenuURLuserValue

    Remarks

    If member name is set it is possible to read out and change the value belonging to this option using GetPluginData and SavePluginData. When you read or change a secutity option the functions will return or expect a boolean. The returnvalue is true(1) if the security option is enabled and false(0) if disabled. When you recover or change a user changeable option the functions will return or expect the same value as given in member defaultValue from the structure UserValueOption in member userValue.

    There is one exception for the type multi-column list, the data member should be a pointer to a list.

    Requirements

    Minimum supported API 1.00
    Header tvsserver_base
    .h