• 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
  • UserValueOption structure

    Contains information about the type en default value of a single user changeable-option.

    Syntax

    typedef struct UserValueOption{
    int type;
    int defaultValueSize;
    void* defaultValue;
    } UserValueOption;

    Members

    type
    ValueMeaning
    TD_ASCII_STRING
    0
    The data type is an ascii string. The value defaultValue should be a pointer to a null-terminated string.
    TD_UNICODE_STRING
    1
    The data type is an unicode string. The value defaultValue should be a pointer to a null-terminated unicode-string.
    TD_BOOLEAN
    2
    The data type is a boolean. The value defaultValue is not a pointer but should be an integer. The integer can either be zero (false) or high (true). The value defaultValueSize should be set to zero.
    TD_CHAR
    3
    The data type is a character. The value defaultValue is not a pointer but should be an integer. The first byte of the integer is the character. The value defaultValueSize should be set to zero.
    TD_SHORT_INT
    4
    The data type is a shot integer. The value defaultValue is not a pointer but should be an integer. The first two bytes of the integer is the short integer. The value defaultValueSize should be set to zero.
    TD_INTEGER
    5
    The data type is an integer. The value defaultValue is not a pointer but should be an integer. The value defaultValueSize should be set to zero.
    TD_LARGE_INTEGER
    6
    The data type is a lager integer.
    32 bit: The value defaultValue is a pointer to a long long. The value defaultValueSize should be set to 8.
    64 bit: The value defaultValue is not a pointer but should be a long long. The value defaultValueSize should be set to zero.

    TD_DATE
    7
    The data type is a date. The value defaultValue is not a pointer but should be an integer. The first 5 bits will be used for the day, the 4 bits in the middle for the month and the last 23 bits for the year. You can use the FormatDate() function to create the integer. The value defaultValueSize should be set to zero.
    TD_TIME
    8
    The data type is time. The value defaultValue is not a pointer but should be an integer. The first 5 bits will be used for the hours, the next 6 bits are used for the minutes, the next 6 bits are used for the seconds and the next 10 bits for the miliseconds (the last 5 bits will stay unused). You can use the FormatTime() function to create the integer. The value defaultValueSize should be set to zero.
    TD_DATETIME
    9
    The data type contains a date and time. The value is the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970, not counting leap seconds. You can use the FormatDateTime() function to create the long long.
    32 bit: The value defaultValue is a pointer to a long long. The value defaultValueSize should be set to 8.
    64 bit: The value defaultValue is not a pointer but should be a long long. The value defaultValueSize should be set to zero.
    TD_PROGRESS
    10
    The data type contains status progress. The value defaultValue is a pointer to a CurrentProgress structure. This structure contains the current position, minimum and maximum value of the progress.
    TD_LIST
    11
    The data type is a multi-column list. The value defaultValue is a pointer to a MultiColumnList structure. This structure contains columns and the a pointer to the first row of the list.

    defaultValueSizedefaultValue

    Requirements

    Minimum supported API 1.00
    Header tvsserver_base
    .h