/usr/share/doc/nsis/Docs/Dialer/Dialer.txt is in nsis-doc 2.46-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | DIALER PLUGIN
-------------
Written by Amir Szekely aka KiCHiK
Readme by Joost Verburg
The Dialer plugin for NSIS provides five functions related to internet connections.
To download files from the internet, use the NSISdl plugin.
USAGE
-----
Example of usage:
ClearErrors ;Clear the error flag
Dialer::FunctionName ;Call Dialer function
IfErrors "" +3 ;Check for errors
MessageBox MB_OK "Function not available"
Quit
Pop $R0 ;Get the return value from the stack
MessageBox MB_OK $R0 ;Display the return value
EXAMPLE FUNCTION
----------------
; ConnectInternet (uses Dialer plugin)
; Written by Joost Verburg
;
; This function attempts to make a connection to the internet if there is no
; connection available. If you are not sure that a system using the installer
; has an active internet connection, call this function before downloading
; files with NSISdl.
;
; The function requires Internet Explorer 3, but asks to connect manually if
; IE3 is not installed.
Function ConnectInternet
Push $R0
ClearErrors
Dialer::AttemptConnect
IfErrors noie3
Pop $R0
StrCmp $R0 "online" connected
MessageBox MB_OK|MB_ICONSTOP "Cannot connect to the internet."
Quit ;Remove to make error not fatal
noie3:
; IE3 not installed
MessageBox MB_OK|MB_ICONINFORMATION "Please connect to the internet now."
connected:
Pop $R0
FunctionEnd
FUNCTIONS
---------
If a function is not available on the system, the error flag will be set.
* AttemptConnect
Attempts to make a connection to the Internet if the system is not connected.
online - already connected / connection successful
offline - connection failed
Requires Internet Explorer 3 or later
* AutodialOnline
Causes the modem to automatically dial the default Internet connection if the system
is not connected to the internet. If the system is not set up to automatically
connect, it will prompt the user.
Return values:
online - already connected / connection successful
offline - connection failed
Requires Internet Explorer 4 or later
* AutodialUnattended
Causes the modem to automatically dial the default Internet connection if the system
is not connected to the internet. The user will not be prompted.
Return values:
online - already connected / connection successful
offline - connection failed
Requires Internet Explorer 4 or later
* AutodialHangup
Disconnects an automatic dial-up connection.
Return values:
success - disconnection successful
failure - disconnection failed
Requires Internet Explorer 4 or later
* GetConnectedState
Checks whether the system is connected to the internet.
Return values:
online - system is online
offline - system is offline
Requires Internet Explorer 4 or later
|