_wslua_pref_t Struct Reference

Represents a single Wireshark preference registered from a Lua dissector script. More...

#include <wslua.h>

Public Attributes
char *	name
char *	label
char *	desc
pref_type_e	type
union {
bool   b
unsigned   u
char *   s
int   e
range_t *   r
void *   p
}	value
union {
uint32_t   max_value
struct {
const enum_val_t *   enumvals
bool   radio_buttons
}   enum_info
struct {
uat_field_t *   uat_field_list
}   uat_field_list_info
char *   default_s
}	info
struct _wslua_pref_t *	next
struct _wslua_proto_t *	proto
int	ref

Detailed Description

Represents a single Wireshark preference registered from a Lua dissector script.

Member Data Documentation

b

bool _wslua_pref_t::b

Value for PREF_BOOL preferences.

default_s

char* _wslua_pref_t::default_s

Default string value for PREF_STRING preferences.

desc

char* _wslua_pref_t::desc

Description of the preference shown as a tooltip or help text.

e

int _wslua_pref_t::e

Value for PREF_ENUM preferences (index into enumvals).

[struct]

struct { ... } _wslua_pref_t::enum_info

Metadata for PREF_ENUM preferences.

enumvals

const enum_val_t* _wslua_pref_t::enumvals

NULL-terminated array of name/value pairs for the enumeration.

[union]

union { ... } _wslua_pref_t::info

Display and metadata for the preference, interpreted according to type.

label

char* _wslua_pref_t::label

Human-readable label displayed in the preferences dialog.

max_value

uint32_t _wslua_pref_t::max_value

Maximum allowed value for PREF_UINT range preferences.

name

char* _wslua_pref_t::name

Internal name of the preference used for storage and lookup.

next

struct _wslua_pref_t* _wslua_pref_t::next

Pointer to the next preference in this protocol's linked list of preferences.

p

void* _wslua_pref_t::p

Value for PREF_STATIC_TEXT or other opaque preferences.

proto

struct _wslua_proto_t* _wslua_pref_t::proto

Back-pointer to the Lua proto that owns this preference.

r

range_t* _wslua_pref_t::r

Value for PREF_RANGE preferences.

radio_buttons

bool _wslua_pref_t::radio_buttons

True to display as radio buttons; false to display as a combo box.

ref

int _wslua_pref_t::ref

Lua registry reference used to deregister this preference when the proto is removed.

s

char* _wslua_pref_t::s

Value for PREF_STRING preferences.

type

pref_type_e _wslua_pref_t::type

Type of the preference (PREF_BOOL, PREF_UINT, PREF_STRING, etc.).

u

unsigned _wslua_pref_t::u

Value for PREF_UINT preferences.

uat_field_list

uat_field_t* _wslua_pref_t::uat_field_list

Array of field descriptors defining the columns of the UAT.

[struct]

struct { ... } _wslua_pref_t::uat_field_list_info

Metadata for PREF_UAT preferences.

[union]

union { ... } _wslua_pref_t::value

Current value of the preference, interpreted according to type.

---

The documentation for this struct was generated from the following file:

• /builds/wireshark/wireshark/epan/wslua/wslua.h