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

size

The size of the structure, in bytes. It is allowed to shorten this structure by leaving unused mebers out. This member can be zero if the structure is complete.

flags

This parameter can be zero or a combination of the following values.

Value	Meaning
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.

Or this parameter can be a combination of the following values.

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

Or this parameter can be a combination of the following values.

Value	Meaning
CPO_GEN_PROTOCOL_OPTION 0x20	Set this flag will make this a valid option for the protocol settings.
CPO_GEN_LISTENSESSION_OPTION
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.

And this parameter can be a combination of the following values, combinating with the flags above.

Value	Meaning
GDPD_NAME_IS_INTEGER 0x80	The name paramter is not a pointer to a null-terminated string but an integer to identify the data.

name

A pointer to a null-terminated string conaining a identifier name or an integer if flag GDPD_NAME_IS_INTEGER is set. This name can be used to recover and change the value belonging to this option, see Remarks section for more information. This value is ignored if flag CPO_SHOW_IN_MENU is set.

optionName

A pointer to a null-terminated string, the name of this option. This name is showing when when an administrator grants/prohibits access a certain user for this option or it is showing in the menu, depending on which flags where set. This should be an uTF-8 string. Version 3.1 and below: this should be an ascii string.

description

A pointer to a null-terminated string with a description of this option. This can be used for the user to understand what this option is for, this option will probably be placed on a help page, depending on the configuration plug-in.

groupName

A pointer to a null-terminated list of null-terminated strings. These are names of the group(s) this options should fall under.

iconURL

A pointer to a null-terminated string, an URL to a 16x16 image that will displayed next to the name.

bigIconURL

A pointer to a null-terminated string, an URL to a 32x32 image that will displayed next to the name.

menuURL

A pointer to a null-terminated string, an URL where the link in the menu will redirect to. This value is ignored if flag POF_SHOW_IN_MENU is not set.

userValue

A pointer to a UserValueOption structure with default value and type of this option. This value is ignored if flag POF_GEN_PLUGIN_OPTION or flag POF_GEN_LISTENSESSION_OPTION is not set.

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