application_flavor.h File Reference

#include <wireshark.h>

Go to the source code of this file.

Enumerations
enum	application_flavor_e { APPLICATION_FLAVOR_WIRESHARK , APPLICATION_FLAVOR_STRATOSHARK }

Functions
WS_DLL_PUBLIC void	set_application_flavor (enum application_flavor_e flavor)
WS_DLL_PUBLIC enum application_flavor_e	get_application_flavor (void)
WS_DLL_PUBLIC const char *	application_flavor_name_proper (void)
WS_DLL_PUBLIC const char *	application_flavor_name_lower (void)
WS_DLL_PUBLIC enum application_flavor_e	application_name_to_flavor (const char *name)
WS_DLL_PUBLIC bool	application_flavor_is_wireshark (void)
WS_DLL_PUBLIC bool	application_flavor_is_stratoshark (void)

Detailed Description

Application flavor definitions

Wireshark - Network traffic analyzer By Gerald Combs geral.nosp@m.d@wi.nosp@m.resha.nosp@m.rk.o.nosp@m.rg Copyright 1998 Gerald Combs

SPDX-License-Identifier: GPL-2.0-or-later

Function Documentation

application_flavor_is_stratoshark()

WS_DLL_PUBLIC bool application_flavor_is_stratoshark

(

void

)

Convenience routine for checking the application flavor.

Returns

true if the application flavor is APPLICATION_FLAVOR_STRATOSHARK.

application_flavor_is_wireshark()

WS_DLL_PUBLIC bool application_flavor_is_wireshark

(

void

)

Convenience routine for checking the application flavor.

Returns

true if the application flavor is APPLICATION_FLAVOR_WIRESHARK.

application_flavor_name_lower()

WS_DLL_PUBLIC const char * application_flavor_name_lower

(

void

)

Get the lower-case application name.

Returns

The application name. Must not be freed.

application_flavor_name_proper()

WS_DLL_PUBLIC const char * application_flavor_name_proper

(

void

)

Get the proper (capitalized) application name, suitable for user presentation.

Returns

The application name. Must not be freed.

application_name_to_flavor()

WS_DLL_PUBLIC enum application_flavor_e application_name_to_flavor

(

const char *

name

)

Get an application flavor from its name.

Parameters

name	The application name. Case insensitive.

Returns

The application flavor, or APPLICATION_FLAVOR_WIRESHARK if there is no match.

get_application_flavor()

WS_DLL_PUBLIC enum application_flavor_e get_application_flavor

(

void

)

Get our application flavor.

Returns

The flavor.

set_application_flavor()

WS_DLL_PUBLIC void set_application_flavor

(

enum application_flavor_e

flavor

)

Initialize our application flavor.

Set our application flavor, which determines the top-level configuration directory name and environment variable prefixes. Default is APPLICATION_FLAVOR_WIRESHARK.

Parameters

flavor

Application flavor.