| Wireshark 4.7.3 The Wireshark network protocol analyzer

Loading...
Searching...
No Matches
help_url.h
Go to the documentation of this file.
1
11
12#ifndef __HELP_URL_H__
13#define __HELP_URL_H__
14
15#include <ws_attributes.h>
16
17#ifdef __cplusplus
18 extern "C" {
19#endif /* __cplusplus */
20
24
28 typedef enum {
29 TOPIC_ACTION_NONE,
30
31 /* pages online at www.wireshark.org */
32 ONLINEPAGE_WIRESHARK_HOME,
33 ONLINEPAGE_WIRESHARK_WIKI,
34 ONLINEPAGE_USERGUIDE,
35 ONLINEPAGE_FAQ,
36 ONLINEPAGE_WIRESHARK_DOWNLOAD,
37 ONLINEPAGE_DOCS,
38 ONLINEPAGE_SAMPLE_FILES,
39 ONLINEPAGE_CAPTURE_SETUP,
40 ONLINEPAGE_NETWORK_MEDIA,
41 ONLINEPAGE_SAMPLE_CAPTURES,
42 ONLINEPAGE_SECURITY,
43 ONLINEPAGE_ASK,
44 ONLINEPAGE_DFILTER_REF,
45
46 /* pages online at stratoshark.org */
47 ONLINEPAGE_STRATOSHARK_HOME,
48 ONLINEPAGE_STRATOSHARK_WIKI,
49 ONLINEPAGE_STRATOSHARK_DOWNLOAD,
50
51 /* local manual pages */
52 LOCALPAGE_MAN_WIRESHARK = 100,
53 LOCALPAGE_MAN_STRATOSHARK,
54 LOCALPAGE_MAN_WIRESHARK_FILTER,
55 LOCALPAGE_MAN_CAPINFOS,
56 LOCALPAGE_MAN_DUMPCAP,
57 LOCALPAGE_MAN_EDITCAP,
58 LOCALPAGE_MAN_MERGECAP,
59 LOCALPAGE_MAN_RAWSHARK,
60 LOCALPAGE_MAN_REORDERCAP,
61 LOCALPAGE_MAN_TEXT2PCAP,
62 LOCALPAGE_MAN_TSHARK,
63
64 /* Release Notes */
65 LOCALPAGE_WIRESHARK_RELEASE_NOTES,
66 LOCALPAGE_STRATOSHARK_RELEASE_NOTES,
67
68 /* help pages (textfiles or HTML User's Guide) */
69 HELP_CONTENT = 200,
70 HELP_GETTING_STARTED,
71 HELP_CAPTURE_OPTIONS,
72 HELP_CAPTURE_FILTERS_DIALOG,
73 HELP_DISPLAY_FILTERS_DIALOG,
74 HELP_FILTER_EXPRESSION_DIALOG,
75 HELP_DISPLAY_MACRO_DIALOG,
76 HELP_COLORING_RULES_DIALOG,
77 HELP_CONFIG_PROFILES_DIALOG,
78 HELP_PRINT_DIALOG,
79 HELP_FIND_DIALOG,
80 HELP_FILESET_DIALOG,
81 HELP_FIREWALL_DIALOG,
82 HELP_GOTO_DIALOG,
83 HELP_CAPTURE_OPTIONS_DIALOG,
84 HELP_CAPTURE_MANAGE_INTERFACES_DIALOG,
85 HELP_ENABLED_PROTOCOLS_DIALOG,
86 HELP_ENABLED_HEURISTICS_DIALOG,
87 HELP_DECODE_AS_DIALOG,
88 HELP_DECODE_AS_SHOW_DIALOG,
89 HELP_FOLLOW_STREAM_DIALOG,
90 HELP_SHOW_PACKET_BYTES_DIALOG,
91 HELP_EXPERT_INFO_DIALOG,
92 HELP_EXTCAP_OPTIONS_DIALOG,
93 HELP_STATS_SUMMARY_DIALOG,
94 HELP_STATS_PROTO_HIERARCHY_DIALOG,
95 HELP_STATS_ENDPOINTS_DIALOG,
96 HELP_STATS_CONVERSATIONS_DIALOG,
97 HELP_STATS_IO_GRAPH_DIALOG,
98 HELP_STATS_LTE_MAC_TRAFFIC_DIALOG,
99 HELP_STATS_LTE_RLC_TRAFFIC_DIALOG,
100 HELP_STATS_TCP_STREAM_GRAPHS_DIALOG,
101 HELP_STATS_WLAN_TRAFFIC_DIALOG,
102 HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG,
103 HELP_PREFERENCES_DIALOG,
104 HELP_CAPTURE_INFO_DIALOG,
105 HELP_EXPORT_FILE_DIALOG,
106 HELP_EXPORT_BYTES_DIALOG,
107 HELP_EXPORT_PDUS_DIALOG,
108 HELP_STRIP_HEADERS_DIALOG,
109 HELP_EXPORT_OBJECT_LIST,
110 HELP_OPEN_DIALOG,
111 HELP_MERGE_DIALOG,
112 HELP_IMPORT_DIALOG,
113 HELP_SAVE_DIALOG,
114 HELP_EXPORT_FILE_WIN32_DIALOG,
115 HELP_OPEN_WIN32_DIALOG,
116 HELP_MERGE_WIN32_DIALOG,
117 HELP_SAVE_WIN32_DIALOG,
118 HELP_TIME_SHIFT_DIALOG,
119 HELP_TELEPHONY_VOIP_CALLS_DIALOG,
120 HELP_TELEPHONY_RTP_ANALYSIS_DIALOG,
121 HELP_TELEPHONY_RTP_STREAMS_DIALOG,
122 HELP_NEW_PACKET_DIALOG,
123 HELP_IAX2_ANALYSIS_DIALOG,
124 HELP_TELEPHONY_RTP_PLAYER_DIALOG,
125 HELP_STAT_FLOW_GRAPH,
126 HELP_STATS_PLOT_DIALOG
127} topic_action_e;
128
136WS_RETNONNULL char *user_guide_url(const char *page);
137
144WS_RETNONNULL char *topic_action_url(topic_action_e action);
145
150 void topic_action(topic_action_e topic);
151
152#ifdef __cplusplus
153}
154#endif /* __cplusplus */
155
156#endif /* __HELP_URL_H__ */
topic_action
void topic_action(topic_action_e topic)
Definition main_application.cpp:138
topic_action_url
WS_RETNONNULL char * topic_action_url(topic_action_e action)
Definition help_url.c:66
topic_action_e
topic_action_e
Identifies a help topic or navigable destination reachable from the UI help system.
Definition help_url.h:28
HELP_CAPTURE_INFO_DIALOG
@ HELP_CAPTURE_INFO_DIALOG
Definition help_url.h:104
HELP_EXPORT_FILE_DIALOG
@ HELP_EXPORT_FILE_DIALOG
Definition help_url.h:105
HELP_MERGE_WIN32_DIALOG
@ HELP_MERGE_WIN32_DIALOG
Definition help_url.h:116
HELP_FIND_DIALOG
@ HELP_FIND_DIALOG
Definition help_url.h:79
HELP_PREFERENCES_DIALOG
@ HELP_PREFERENCES_DIALOG
Definition help_url.h:103
HELP_SHOW_PACKET_BYTES_DIALOG
@ HELP_SHOW_PACKET_BYTES_DIALOG
Definition help_url.h:90
HELP_STATS_LTE_MAC_TRAFFIC_DIALOG
@ HELP_STATS_LTE_MAC_TRAFFIC_DIALOG
Definition help_url.h:98
HELP_STATS_LTE_RLC_TRAFFIC_DIALOG
@ HELP_STATS_LTE_RLC_TRAFFIC_DIALOG
Definition help_url.h:99
HELP_COLORING_RULES_DIALOG
@ HELP_COLORING_RULES_DIALOG
Definition help_url.h:76
HELP_STAT_FLOW_GRAPH
@ HELP_STAT_FLOW_GRAPH
Definition help_url.h:125
LOCALPAGE_MAN_EDITCAP
@ LOCALPAGE_MAN_EDITCAP
Definition help_url.h:57
HELP_FILTER_EXPRESSION_DIALOG
@ HELP_FILTER_EXPRESSION_DIALOG
Definition help_url.h:74
ONLINEPAGE_USERGUIDE
@ ONLINEPAGE_USERGUIDE
Definition help_url.h:34
LOCALPAGE_MAN_WIRESHARK
@ LOCALPAGE_MAN_WIRESHARK
Definition help_url.h:52
HELP_FILESET_DIALOG
@ HELP_FILESET_DIALOG
Definition help_url.h:80
HELP_CONTENT
@ HELP_CONTENT
Definition help_url.h:69
HELP_TIME_SHIFT_DIALOG
@ HELP_TIME_SHIFT_DIALOG
Definition help_url.h:118
HELP_STATS_TCP_STREAM_GRAPHS_DIALOG
@ HELP_STATS_TCP_STREAM_GRAPHS_DIALOG
Definition help_url.h:100
HELP_EXPORT_OBJECT_LIST
@ HELP_EXPORT_OBJECT_LIST
Definition help_url.h:109
HELP_STATS_PROTO_HIERARCHY_DIALOG
@ HELP_STATS_PROTO_HIERARCHY_DIALOG
Definition help_url.h:94
ONLINEPAGE_SAMPLE_CAPTURES
@ ONLINEPAGE_SAMPLE_CAPTURES
Definition help_url.h:41
HELP_TELEPHONY_RTP_PLAYER_DIALOG
@ HELP_TELEPHONY_RTP_PLAYER_DIALOG
Definition help_url.h:124
HELP_TELEPHONY_RTP_ANALYSIS_DIALOG
@ HELP_TELEPHONY_RTP_ANALYSIS_DIALOG
Definition help_url.h:120
LOCALPAGE_MAN_REORDERCAP
@ LOCALPAGE_MAN_REORDERCAP
Definition help_url.h:60
HELP_EXPORT_BYTES_DIALOG
@ HELP_EXPORT_BYTES_DIALOG
Definition help_url.h:106
ONLINEPAGE_FAQ
@ ONLINEPAGE_FAQ
Definition help_url.h:35
HELP_EXTCAP_OPTIONS_DIALOG
@ HELP_EXTCAP_OPTIONS_DIALOG
Definition help_url.h:92
HELP_STATS_IO_GRAPH_DIALOG
@ HELP_STATS_IO_GRAPH_DIALOG
Definition help_url.h:97
HELP_CAPTURE_OPTIONS
@ HELP_CAPTURE_OPTIONS
Definition help_url.h:71
LOCALPAGE_MAN_WIRESHARK_FILTER
@ LOCALPAGE_MAN_WIRESHARK_FILTER
Definition help_url.h:54
HELP_DECODE_AS_SHOW_DIALOG
@ HELP_DECODE_AS_SHOW_DIALOG
Definition help_url.h:88
HELP_STATS_WLAN_TRAFFIC_DIALOG
@ HELP_STATS_WLAN_TRAFFIC_DIALOG
Definition help_url.h:101
HELP_FOLLOW_STREAM_DIALOG
@ HELP_FOLLOW_STREAM_DIALOG
Definition help_url.h:89
HELP_GOTO_DIALOG
@ HELP_GOTO_DIALOG
Definition help_url.h:82
HELP_ENABLED_HEURISTICS_DIALOG
@ HELP_ENABLED_HEURISTICS_DIALOG
Definition help_url.h:86
TOPIC_ACTION_NONE
@ TOPIC_ACTION_NONE
Definition help_url.h:29
ONLINEPAGE_WIRESHARK_WIKI
@ ONLINEPAGE_WIRESHARK_WIKI
Definition help_url.h:33
HELP_TELEPHONY_RTP_STREAMS_DIALOG
@ HELP_TELEPHONY_RTP_STREAMS_DIALOG
Definition help_url.h:121
ONLINEPAGE_STRATOSHARK_DOWNLOAD
@ ONLINEPAGE_STRATOSHARK_DOWNLOAD
Definition help_url.h:49
HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG
@ HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG
Definition help_url.h:102
ONLINEPAGE_WIRESHARK_DOWNLOAD
@ ONLINEPAGE_WIRESHARK_DOWNLOAD
Definition help_url.h:36
HELP_SAVE_WIN32_DIALOG
@ HELP_SAVE_WIN32_DIALOG
Definition help_url.h:117
HELP_DISPLAY_MACRO_DIALOG
@ HELP_DISPLAY_MACRO_DIALOG
Definition help_url.h:75
ONLINEPAGE_STRATOSHARK_WIKI
@ ONLINEPAGE_STRATOSHARK_WIKI
Definition help_url.h:48
ONLINEPAGE_NETWORK_MEDIA
@ ONLINEPAGE_NETWORK_MEDIA
Definition help_url.h:40
HELP_CAPTURE_MANAGE_INTERFACES_DIALOG
@ HELP_CAPTURE_MANAGE_INTERFACES_DIALOG
Definition help_url.h:84
HELP_SAVE_DIALOG
@ HELP_SAVE_DIALOG
Definition help_url.h:113
HELP_EXPORT_FILE_WIN32_DIALOG
@ HELP_EXPORT_FILE_WIN32_DIALOG
Definition help_url.h:114
LOCALPAGE_STRATOSHARK_RELEASE_NOTES
@ LOCALPAGE_STRATOSHARK_RELEASE_NOTES
Definition help_url.h:66
HELP_ENABLED_PROTOCOLS_DIALOG
@ HELP_ENABLED_PROTOCOLS_DIALOG
Definition help_url.h:85
LOCALPAGE_MAN_MERGECAP
@ LOCALPAGE_MAN_MERGECAP
Definition help_url.h:58
ONLINEPAGE_WIRESHARK_HOME
@ ONLINEPAGE_WIRESHARK_HOME
Definition help_url.h:32
ONLINEPAGE_ASK
@ ONLINEPAGE_ASK
Definition help_url.h:43
HELP_OPEN_DIALOG
@ HELP_OPEN_DIALOG
Definition help_url.h:110
HELP_STRIP_HEADERS_DIALOG
@ HELP_STRIP_HEADERS_DIALOG
Definition help_url.h:108
ONLINEPAGE_DOCS
@ ONLINEPAGE_DOCS
Definition help_url.h:37
HELP_STATS_ENDPOINTS_DIALOG
@ HELP_STATS_ENDPOINTS_DIALOG
Definition help_url.h:95
HELP_NEW_PACKET_DIALOG
@ HELP_NEW_PACKET_DIALOG
Definition help_url.h:122
HELP_STATS_PLOT_DIALOG
@ HELP_STATS_PLOT_DIALOG
Definition help_url.h:126
ONLINEPAGE_DFILTER_REF
@ ONLINEPAGE_DFILTER_REF
Definition help_url.h:44
HELP_PRINT_DIALOG
@ HELP_PRINT_DIALOG
Definition help_url.h:78
LOCALPAGE_MAN_CAPINFOS
@ LOCALPAGE_MAN_CAPINFOS
Definition help_url.h:55
HELP_TELEPHONY_VOIP_CALLS_DIALOG
@ HELP_TELEPHONY_VOIP_CALLS_DIALOG
Definition help_url.h:119
HELP_OPEN_WIN32_DIALOG
@ HELP_OPEN_WIN32_DIALOG
Definition help_url.h:115
HELP_DECODE_AS_DIALOG
@ HELP_DECODE_AS_DIALOG
Definition help_url.h:87
HELP_EXPERT_INFO_DIALOG
@ HELP_EXPERT_INFO_DIALOG
Definition help_url.h:91
HELP_STATS_CONVERSATIONS_DIALOG
@ HELP_STATS_CONVERSATIONS_DIALOG
Definition help_url.h:96
ONLINEPAGE_CAPTURE_SETUP
@ ONLINEPAGE_CAPTURE_SETUP
Definition help_url.h:39
HELP_STATS_SUMMARY_DIALOG
@ HELP_STATS_SUMMARY_DIALOG
Definition help_url.h:93
HELP_FIREWALL_DIALOG
@ HELP_FIREWALL_DIALOG
Definition help_url.h:81
HELP_MERGE_DIALOG
@ HELP_MERGE_DIALOG
Definition help_url.h:111
ONLINEPAGE_SECURITY
@ ONLINEPAGE_SECURITY
Definition help_url.h:42
ONLINEPAGE_STRATOSHARK_HOME
@ ONLINEPAGE_STRATOSHARK_HOME
Definition help_url.h:47
LOCALPAGE_MAN_RAWSHARK
@ LOCALPAGE_MAN_RAWSHARK
Definition help_url.h:59
HELP_DISPLAY_FILTERS_DIALOG
@ HELP_DISPLAY_FILTERS_DIALOG
Definition help_url.h:73
HELP_IAX2_ANALYSIS_DIALOG
@ HELP_IAX2_ANALYSIS_DIALOG
Definition help_url.h:123
HELP_EXPORT_PDUS_DIALOG
@ HELP_EXPORT_PDUS_DIALOG
Definition help_url.h:107
HELP_IMPORT_DIALOG
@ HELP_IMPORT_DIALOG
Definition help_url.h:112
HELP_GETTING_STARTED
@ HELP_GETTING_STARTED
Definition help_url.h:70
HELP_CAPTURE_FILTERS_DIALOG
@ HELP_CAPTURE_FILTERS_DIALOG
Definition help_url.h:72
HELP_CAPTURE_OPTIONS_DIALOG
@ HELP_CAPTURE_OPTIONS_DIALOG
Definition help_url.h:83
LOCALPAGE_MAN_TSHARK
@ LOCALPAGE_MAN_TSHARK
Definition help_url.h:62
ONLINEPAGE_SAMPLE_FILES
@ ONLINEPAGE_SAMPLE_FILES
Definition help_url.h:38
HELP_CONFIG_PROFILES_DIALOG
@ HELP_CONFIG_PROFILES_DIALOG
Definition help_url.h:77
LOCALPAGE_WIRESHARK_RELEASE_NOTES
@ LOCALPAGE_WIRESHARK_RELEASE_NOTES
Definition help_url.h:65
LOCALPAGE_MAN_STRATOSHARK
@ LOCALPAGE_MAN_STRATOSHARK
Definition help_url.h:53
LOCALPAGE_MAN_TEXT2PCAP
@ LOCALPAGE_MAN_TEXT2PCAP
Definition help_url.h:61
LOCALPAGE_MAN_DUMPCAP
@ LOCALPAGE_MAN_DUMPCAP
Definition help_url.h:56
user_guide_url
WS_RETNONNULL char * user_guide_url(const char *page)
Definition help_url.c:32