application doc update
authorKevin P. Fleming <kpfleming@digium.com>
Mon, 7 Nov 2005 22:01:22 +0000 (22:01 +0000)
committerKevin P. Fleming <kpfleming@digium.com>
Mon, 7 Nov 2005 22:01:22 +0000 (22:01 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6992 65c4cc65-6c06-0410-ace0-fbb531ad65f3

53 files changed:
ChangeLog
apps/app_adsiprog.c
apps/app_authenticate.c
apps/app_chanisavail.c
apps/app_controlplayback.c
apps/app_curl.c
apps/app_cut.c
apps/app_datetime.c
apps/app_db.c
apps/app_dial.c
apps/app_directory.c
apps/app_disa.c
apps/app_dumpchan.c
apps/app_echo.c
apps/app_enumlookup.c
apps/app_flash.c
apps/app_getcpeid.c
apps/app_groupcount.c
apps/app_ices.c
apps/app_image.c
apps/app_intercom.c
apps/app_lookupblacklist.c
apps/app_lookupcidname.c
apps/app_macro.c
apps/app_math.c
apps/app_md5.c
apps/app_meetme.c
apps/app_mp3.c
apps/app_nbscat.c
apps/app_page.c
apps/app_playback.c
apps/app_privacy.c
apps/app_queue.c
apps/app_read.c
apps/app_record.c
apps/app_sayunixtime.c
apps/app_senddtmf.c
apps/app_sendtext.c
apps/app_setcallerid.c
apps/app_setcdruserfield.c
apps/app_setcidname.c
apps/app_setcidnum.c
apps/app_setrdnis.c
apps/app_settransfercapability.c
apps/app_sms.c
apps/app_softhangup.c
apps/app_striplsd.c
apps/app_system.c
apps/app_talkdetect.c
apps/app_verbose.c
apps/app_voicemail.c
apps/app_zapateller.c
apps/app_zapras.c

index 78016cc..5de6719 100755 (executable)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2005-11-07  Kevin P. Fleming  <kpfleming@digium.com>
+
+       * many files: clean up application documentation to not refer to return values, since they cannot be used in the dialplan (work done by Neil Lewis)
+
 2005-11-06  Russell Bryant <russell@digium.com>
 
        * many files: alphabetize options in applicaiton descriptions
index 21eed09..0d77587 100755 (executable)
@@ -56,8 +56,9 @@ static char *synopsis = "Load Asterisk ADSI Scripts into phone";
 
 static char *descrip =
 "  ADSIProg(script): Programs an ADSI Phone with the given script.\n"
-"If none is specified, the default is used.  Returns 0 unless CPE\n" 
-"is hungup.\n";
+"If none is specified, the default script is used.  The reprogramming\n"  
+"will complete successfully, except in cases where the device is  \n"
+"disconnected or hungup.\n";
 
 STANDARD_LOCAL_USER;
 
index 244f5b4..a3f5f91 100755 (executable)
@@ -65,11 +65,10 @@ static char *descrip =
 "     r - Remove database key upon successful entry (valid with 'd' only)\n"
 "\n"
 "When using a database key, the value associated with the key can be\n"
-"anything.\n"
-"Returns 0 if the user enters a valid password within three\n"
-"tries, or -1 on hangup.  If the priority n+101 exists and invalid\n"
-"authentication was entered, and the 'j' flag was specified, processing\n"
-"will jump to n+101 and 0 will be returned.\n";
+"anything.  Users have three attempts to authenticate before the line is \n"
+"hungup.  If the passsword is invalid, and the 'j' flag is specified, \n"
+"and priority n+101 exists, the call would be sent to the n+101 priority \n"
+"and executed \n";
 
 STANDARD_LOCAL_USER;
 
index 957f412..10a377f 100755 (executable)
@@ -52,16 +52,18 @@ static char *synopsis = "Check if channel is available";
 
 static char *descrip = 
 "  ChanIsAvail(Technology/resource[&Technology2/resource2...][|option]): \n"
-"Checks is any of the requested channels are available.  \n"
-"If any of the requested channels are available, the next priority will be n+1,\n"
-"the channel variable ${AVAILCHAN} will be set to the name of the available channel\n"
-"and the ChanIsAvail app will return 0.\n"
-"${AVAILORIGCHAN} is the canonical channel name that was used to create the channel.\n"
-"${AVAILSTATUS} is the status code for the channel.\n"
+"Checks if any of the requested channels are available.  \n"
+"If any of the requested channels are available, the dialplan will continue and:\n"
+"  ${AVAILCHAN} will be set to the name of the available channel\n"
+"  ${AVAILORIGCHAN} is the canonical channel name that was used to create the channel\n"
+"  ${AVAILSTATUS} is the status code for the channel\n"
 "If the option 's' is specified (state), will consider channel unavailable\n"
 "when the channel is in use at all, even if it can take another call.\n"
-"If the option 'j' is specified (jump), the application will jump to n+101 \n"
-"(unless such a priority does not exist, in which case ChanIsAvail will return -1)\n";
+"If none of the requested channels are available, then:\n"
+"  if the option 'j' is specified (jump), the application will jump to n+101\n"
+"    if it exists, otherwise the call will terminate\n"
+"  if the option 'j' is not specified the dialplan will continue and\n"
+"    ${AVAILCHAN} will be empty\n";
 
 STANDARD_LOCAL_USER;
 
index 41e0606..47b82ac 100755 (executable)
@@ -48,16 +48,15 @@ static const char *synopsis = "Play a file with fast forward and rewind";
 
 static const char *descrip = 
 "ControlPlayback(filename[|skipms[|ffchar[|rewchar[|stopchar[|pausechar[|restartchar[|option]]]]]]]):\n"
-"  Plays  back  a  given  filename (do not put extension). Options may also\n"
+"  Plays back a given filename (do not put extension). Options may also\n"
 "  be included following a pipe symbol.  You can use * and # to rewind and\n"
 "  fast forward the playback specified. If 'stopchar' is added the file will\n"
 "  terminate playback when 'stopchar' is pressed. If 'restartchar' is added, the file\n"
-"  will restart when 'restartchar' is pressed. Returns -1 if the channel\n"
-"  was hung up. \n\n"
-"  The option string may contain zero or the following character:\n"
+"  will restart when 'restartchar' is pressed.\n"
+"  The option string may contain the following character:\n"
 "       'j' -- jump to +101 priority if the file requested isn't found.\n"
 "  This application sets the following channel variable upon completion:\n"
-"     CPLAYBACKSTATUS       The status of the attempt to add a queue member as a text string, one of\n"
+"     CPLAYBACKSTATUS       The status of the attempt as a text string, one of\n"
 "             SUCCESS | USERSTOPPED | ERROR\n"
 "  Example:  exten => 1234,1,ControlPlayback(file|4000|*|#|1|0|5)\n\n";
 
index 7b2a962..07a26d9 100755 (executable)
@@ -48,7 +48,7 @@ static char *synopsis = "Load an external URL";
 
 static char *descrip = 
 "  Curl(URL[|postdata]): Requests the URL.  Mainly used for signalling\n"
-"external applications of an event.  Returns 0 or -1 on fatal error.\n"
+"external applications of an event.  Curl will fail on fatal errors. \n"
 "Argument specified treated as POST data.  Also sets CURL variable with the\n"
 "resulting page.\n";
 
index 7d210df..718583e 100755 (executable)
@@ -56,7 +56,7 @@ static char *cut_descrip =
 "  fieldspec - number of the field you want (1-based offset)\n"
 "            may also be specified as a range (with -)\n"
 "            or group of ranges and fields (with &)\n" 
-"  Returns 0 or -1 on hangup or error.\n";
+"  The process with complete on success or fail on hangup or error\n";
 
 static char *app_sort = "Sort";
 static char *app_sort_synopsis = "Sorts a list of keywords and values";
@@ -64,7 +64,7 @@ static char *app_sort_descrip =
 "   Sort(<newvar>=<key1>:<val1>[,<key2>:<val2>[[...],<keyN>:<valN>]])\n"
 "Sorts the list provided by using the value as a float to order the list of\n"
 "keywords in ascending order.  Sets the variable provided to the list of\n"
-"sorted keywords.  Always returns 0.\n";
+"sorted keywords. \n";
 
 STANDARD_LOCAL_USER;
 
index c384e3c..d5414a4 100755 (executable)
@@ -45,8 +45,8 @@ static char *app = "DateTime";
 static char *synopsis = "Say the date and time";
 
 static char *descrip = 
-"  DateTime():  Says the current date and time.  Returns -1 on hangup or 0\n"
-"otherwise.\n";
+"  DateTime():  Says the current date and time.  Terminates on hangup or\n"
+"completion.\n";
 
 STANDARD_LOCAL_USER;
 
index c0e8396..60d25f0 100755 (executable)
@@ -48,24 +48,23 @@ static char *tdesc = "Database access functions for Asterisk extension logic";
 
 static char *g_descrip =
        "  DBget(varname=family/key[|options]): Retrieves a value from the Asterisk\n"
-       "database and stores it in the given variable.  Always returns 0.  \n"
-       "  The option string may contain zero or the following character:\n"
-       "       'j' -- jump to +101 priority if the file requested family/key isn't found.\n"
+       "database and stores it in the given variable.\n"
+       "  The option string may contain the following character:\n"
+       "       'j' -- jump to +101 priority if the requested family/key isn't found.\n"
        "  This application sets the following channel variable upon completion:\n"
-       "     DBGETSTATUS       The status of the attempt to add a queue member as a text string, one of\n"
+       "     DBGETSTATUS       The status of the attempt as a text string, one of\n"
        "             FOUND | NOTFOUND \n";
 
 static char *p_descrip =
        "  DBput(family/key=value): Stores the given value in the Asterisk\n"
-       "database.  Always returns 0.\n";
+       "database.\n";
 
 static char *d_descrip =
-       "  DBdel(family/key): Deletes a key from the Asterisk database.  Always\n"
-       "returns 0.\n";
+       "  DBdel(family/key): Deletes a key from the Asterisk database.\n";
 
 static char *dt_descrip =
        "  DBdeltree(family[/keytree]): Deletes a family or keytree from the Asterisk\n"
-       "database.  Always returns 0.\n";
+       "database.\n";
 
 static char *g_app = "DBget";
 static char *p_app = "DBput";
index 75b5129..7aa042b 100755 (executable)
@@ -70,14 +70,14 @@ static char *descrip =
 "which first answered. All other calls placed by the Dial app will be hung up.\n"
 "If a timeout is not specified, the Dial application will wait indefinitely\n"
 "until either one of the called channels answers, the user hangs up, or all\n"
-"channels return busy or error. In general, the dialer will return 0 if it\n"
-"was unable to place the call, or the timeout expired. \n"
+"channels return busy or error. The dialplan will continue execution if the\n"
+"the calls cannot be placed, or if the timeout expires.\n"
 "  For the Privacy and Screening Modes, the DIALSTATUS variable will be set to DONTCALL, \n"
 "if the called party chooses to send the calling party to the 'Go Away' script, and \n"
 "the DIALSTATUS variable will be set to TORTURE, if the called party wants to send the caller to \n"
 "the TORTURE scripts\n"
-"  This application returns -1 if the originating channel hangs up, or if the\n"
-"call is bridged and either of the parties in the bridge terminate the call.\n"
+"  This application will report normal termination if the originating channel hangs up, or if the\n"
+"call is bridged and either of the parties in the bridge ends the call.\n"
 "The option string may contain zero or more of the following characters:\n"
 "      'A(x)' -- play an announcement to the called party, using x as file\n"
 "      'C' -- reset call detail record for this call.\n"
index 75b724e..3e4472f 100755 (executable)
@@ -49,14 +49,13 @@ static char *synopsis = "Provide directory of voicemail extensions";
 static char *descrip =
 "  Directory(vm-context[|dial-context[|options]]): Presents the user with a directory\n"
 "of extensions from which they  may  select  by name. The  list  of  names \n"
-"and  extensions  is discovered from  voicemail.conf. The  vm-context  argument\n"
+"and  extensions are retrieved from  voicemail.conf. The  vm-context  argument\n"
 "is required, and specifies  the  context  of voicemail.conf to use.  The\n"
 "dial-context is the context to use for dialing the users, and defaults to\n"
 "the vm-context if unspecified. The 'f' option causes the directory to match\n"
 "based on the first name in voicemail.conf instead of the last name.\n"
-"Returns 0 unless the user hangs up. It  also sets up the channel on exit\n"
-"to enter the extension the user selected.  If the user enters '0' and there\n"
-"exists an extension 'o' in the current context, the directory will exit with 0\n"
+"The query should yield a contact unless the caller disconnects.\n"
+"It  also sets up the channel on exit to enter the extension the user selected.\n"  "If the user enters '0' and there exists an extension 'o' in the current \n"" context, the directory will contact the extension associated with 'o'\n"
 "and call control will resume at that extension.  Entering '*' will exit similarly,\n"
 "but to the 'a' extension, much like app_voicemail's behavior.\n";
 
index 7cd9db8..8a26ba5 100755 (executable)
@@ -95,7 +95,6 @@ static char *descrip =
        "If the user enters an invalid extension and extension \"i\" (invalid) \n"
        "exists in the context, it will be used.\n";
 
-
 STANDARD_LOCAL_USER;
 
 LOCAL_USER_DECL;
index 3bdce81..15fb3ba 100755 (executable)
@@ -51,7 +51,7 @@ static char *desc =
 "Displays information on channel and listing of all channel\n"
 "variables. If min_verbose_level is specified, output is only\n"
 "displayed when the verbose level is currently set to that number\n"
-"or greater. Always returns 0.\n\n";
+"or greater. \n";
 
 STANDARD_LOCAL_USER;
 
index 2674d71..1fbfba5 100755 (executable)
@@ -45,8 +45,9 @@ static char *app = "Echo";
 static char *synopsis = "Echo audio read back to the user";
 
 static char *descrip = 
-"  Echo():  Echo audio read from channel back to the channel. Returns 0\n"
-"if the user exits with the '#' key, or -1 if the user hangs up.\n";
+"  Echo():  Echo audio read from channel back to the channel. \n"
+"User can exit the application by either pressing the '#' key, \n"
+"or hanging up.\n";
 
 STANDARD_LOCAL_USER;
 
index cc07ea7..6ff2141 100755 (executable)
@@ -55,7 +55,6 @@ static char *descrip =
 "  EnumLookup(exten[|option]):  Looks up an extension via ENUM and sets\n"
 "the variable 'ENUM'. For VoIP URIs this variable will \n"
 "look like 'TECHNOLOGY/URI' with the appropriate technology.\n"
-"Returns -1 on hangup, or 0 on completion\n"
 "Currently, the enumservices SIP, H323, IAX, IAX2 and TEL are recognized. \n"
 "\nReturns status in the ENUMSTATUS channel variable:\n"
 "    ERROR     Failed to do a lookup\n"
index 8ffe849..9a53dd3 100755 (executable)
@@ -56,8 +56,7 @@ static char *synopsis = "Flashes a Zap Trunk";
 static char *descrip = 
 "  Flash(): Sends a flash on a zap trunk.  This is only a hack for\n"
 "people who want to perform transfers and such via AGI and is generally\n"
-"quite useless otherwise.  Returns 0 on success or -1 if this is not\n"
-"a zap trunk\n";
+"quite useless oths application will only work on Zap trunks.\n";
 
 STANDARD_LOCAL_USER;
 
index 8ab8524..0eb1691 100755 (executable)
@@ -48,8 +48,7 @@ static char *synopsis = "Get ADSI CPE ID";
 
 static char *descrip =
 "  GetCPEID: Obtains and displays ADSI CPE ID and other information in order\n"
-"to properly setup zapata.conf for on-hook operations.\n"
-"Returns -1 on hangup only.\n";
+"to properly setup zapata.conf for on-hook operations.\n";
 
 STANDARD_LOCAL_USER;
 
index 95aa927..aa848c2 100755 (executable)
@@ -256,7 +256,7 @@ static char *group_count_descrip =
 "Usage: GetGroupCount([groupname][@category])\n"
 "  Calculates the group count for the specified group, or uses\n"
 "the current channel's group if not specifed (and non-empty).\n"
-"Stores result in GROUPCOUNT.  Always returns 0.\n"
+"Stores result in GROUPCOUNT. \n"
 "This application has been deprecated, please use the function\n"
 "GroupCount.\n";
 
index 61fc181..4c15055 100755 (executable)
@@ -57,8 +57,7 @@ static char *synopsis = "Encode and stream using 'ices'";
 static char *descrip = 
 "  ICES(config.xml) Streams to an icecast server using ices\n"
 "(available separately).  A configuration file must be supplied\n"
-"for ices (see examples/asterisk-ices.conf).  Returns  -1  on\n"
-"hangup or 0 otherwise.\n";
+"for ices (see examples/asterisk-ices.conf). \n";
 
 STANDARD_LOCAL_USER;
 
index f2e8dcb..3e0f858 100755 (executable)
@@ -49,12 +49,13 @@ static char *synopsis = "Send an image file";
 
 static char *descrip = 
 "  SendImage(filename): Sends an image on a channel. \n"
-"SendImage only  returns  0 if  the  image was sent correctly or if\n"
-"the channel does not support image transport, and -1 otherwise.\n"
-"The option string may contain zero or the following character:\n"
+"If the channel supports image transport but the image send\n"
+"fails, the channel will be hung up. Otherwise, the dialplan\n"
+"continues execution.\n"
+"The option string may contain the following character:\n"
 "      'j' -- jump to priority n+101 if the channel doesn't support image transport\n"
 "This application sets the following channel variable upon completion:\n"
-"      SENDIMAGESTATUS         The status is the attempt to send an image as a text string, one of\n"
+"      SENDIMAGESTATUS         The status is the result of the attempt as a text string, one of\n"
 "              OK | NOSUPPORT \n";                     
 
 STANDARD_LOCAL_USER;
index ac2e897..71442a2 100755 (executable)
@@ -68,8 +68,7 @@ static char *app = "Intercom";
 static char *synopsis = "(Obsolete) Send to Intercom";
 static char *descrip = 
 "  Intercom(): Sends the user to the intercom (i.e. /dev/dsp).  This program\n"
-"is generally considered  obselete by the chan_oss module.  Returns 0 if the\n"
-"user exits with a DTMF tone, or -1 if they hangup.\n";
+"is generally considered  obselete by the chan_oss module.  User can terminate\n"with a DTMF tone, or by hangup.\n";
 
 STANDARD_LOCAL_USER;
 
index fa5d481..93d3c8c 100755 (executable)
@@ -53,14 +53,12 @@ static char *synopsis = "Look up Caller*ID name/number from blacklist database";
 static char *descrip =
   "  LookupBlacklist(options): Looks up the Caller*ID number on the active\n"
   "channel in the Asterisk database (family 'blacklist').  \n"
-  "Returns 0.  Does nothing if no Caller*ID was received on the\n"
-  "channel.\n"
-  "The option string may contain zero or the following character:\n"
+  "The option string may contain the following character:\n"
   "    'j' -- jump to n+101 priority if the number/name is found in the blacklist\n"
   "This application sets the following channel variable upon completion:\n"
   "    LOOKUPBLSTATUS          The status of the Blacklist lookup as a text string, one of\n"
   "            FOUND | NOTFOUND\n"
-  "Example: database put blacklist <name/number> 1\n";
+  "Example: exten => 1234,1,LookupBlacklist()\n";
 
 STANDARD_LOCAL_USER;
 
index ca6d3e8..bce2768 100755 (executable)
@@ -54,7 +54,7 @@ static char *descrip =
   "Caller*ID name.  Does nothing if no Caller*ID was received on the\n"
   "channel.  This is useful if you do not subscribe to Caller*ID\n"
   "name delivery, or if you want to change the names on some incoming\n"
-  "calls.  Always returns 0.\n";
+  "calls.\n";
 
 STANDARD_LOCAL_USER;
 
index ac93554..6d99a79 100755 (executable)
@@ -58,7 +58,6 @@ static char *descrip =
 "${ARG1}, ${ARG2}, etc in the macro context.\n"
 "If you Goto out of the Macro context, the Macro will terminate and control\n"
 "will be returned at the location of the Goto.\n"
-"Macro returns -1 if any step in the macro returns -1, and 0 otherwise.\n" 
 "If ${MACRO_OFFSET} is set at termination, Macro will attempt to continue\n"
 "at priority MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise.\n";
 
index e79219c..f1be8d4 100755 (executable)
@@ -69,7 +69,7 @@ static char *math_descrip =
 "Perform floating point calculation on number 1 to number 2 and \n"
 "store the result in returnvar.  Valid ops are: \n"
 "    +,-,/,*,%,<,>,>=,<=,==\n"
-"and behave as their C equivalents.  Always returns 0.\n";
+"and behave as their C equivalents.\n";
 
 #define ADDFUNCTION 0
 #define DIVIDEFUNCTION 1
index 85fb803..b9d5412 100755 (executable)
@@ -46,7 +46,7 @@ static char *app_md5 = "MD5";
 static char *desc_md5 = "Calculate MD5 checksum";
 static char *synopsis_md5 = 
 "  MD5(<var>=<string>): Calculates a MD5 checksum on <string>.\n"
-"Returns hash value in a channel variable. Always return 0\n";
+"Returns hash value in a channel variable. \n";
 
 static char *app_md5check = "MD5Check";
 static char *desc_md5check = "Check MD5 checksum";
index 5af4f7c..bca2ad9 100755 (executable)
@@ -69,7 +69,7 @@ static char *descrip =
 "  MeetMe([confno][,[options][,pin]]): Enters the user into a specified MeetMe conference.\n"
 "If the conference number is omitted, the user will be prompted to enter\n"
 "one. \n"
-"MeetMe returns 0 if user pressed # to exit (see option 'p'), otherwise -1.\n"
+"User can exit the conference by hangup, or if the 'p' option is specified, by pressing '#'.\n"
 "Please note: A ZAPTEL INTERFACE MUST BE INSTALLED FOR CONFERENCING TO WORK!\n\n"
 
 "The option string may contain zero or more of the following characters:\n"
@@ -103,9 +103,10 @@ static char *descrip =
 "             if that variable is not defined.\n";
 
 static char *descrip2 =
-"  MeetMeCount(confno[|var]): Plays back the number of users in the specifiedi\n"
+"  MeetMeCount(confno[|var]): Plays back the number of users in the specified\n"
 "MeetMe conference. If var is specified, playback will be skipped and the value\n"
-"will be returned in the variable. Returns 0 on success or -1 on a hangup.\n"
+"will be returned in the variable. Upon app completion, MeetMeCount will hangup the\n"
+"channel, unless priority n+1 exists, in which case priority progress will continue.\n"
 "A ZAPTEL INTERFACE MUST BE INSTALLED FOR CONFERENCING FUNCTIONALITY.\n";
 
 static char *descrip3 = 
index 3a44067..ee78840 100755 (executable)
@@ -54,9 +54,9 @@ static char *app = "MP3Player";
 static char *synopsis = "Play an MP3 file or stream";
 
 static char *descrip = 
-"  MP3Player(location) Executes mpg123 to play the given location\n"
-"which typically would be a filename o a URL. User can exit by pressing any key\n."
-"Returns  -1  on hangup or 0 otherwise."; 
+"  MP3Player(location) Executes mpg123 to play the given location,\n"
+"which typically would be a filename or a URL. User can exit by pressing\n"
+"any key on the dialpad, or by hanging up."; 
 
 STANDARD_LOCAL_USER;
 
index 97af967..e1fb921 100755 (executable)
@@ -60,8 +60,7 @@ static char *synopsis = "Play an NBS local stream";
 
 static char *descrip = 
 "  NBScat: Executes nbscat to listen to the local NBS stream.\n"
-"Returns  -1  on\n hangup or 0 otherwise. User can exit by \n"
-"pressing any key\n.";
+"User can exit by pressing any key\n.";
 
 STANDARD_LOCAL_USER;
 
index 218c9b2..441208f 100755 (executable)
@@ -54,9 +54,8 @@ static const char *page_descrip =
 "them into a conference bridge as muted participants.  The original\n"
 "caller is dumped into the conference as a speaker and the room is\n"
 "destroyed when the original caller leaves.  Valid options are:\n"
-"      d - full duplex audio\n"
-"      q - quiet, do not play beep to caller\n"
-"Always returns -1.\n";
+"        d - full duplex audio\n"
+"       q - quiet, do not play beep to caller\n";
 
 STANDARD_LOCAL_USER;
 
index 2f280c9..87bb653 100755 (executable)
@@ -51,10 +51,9 @@ static char *descrip =
 "option causes the playback of the message to  be  skipped  if  the  channel\n"
 "is not in the 'up' state (i.e. it hasn't been  answered  yet. If 'skip' is \n"
 "specified, the application will return immediately should the channel not be\n"
-"off hook.  Otherwise, unless 'noanswer' is specified, the channel channel will\n"
+"off hook.  Otherwise, unless 'noanswer' is specified, the channel will\n"
 "be answered before the sound is played. Not all channels support playing\n"
-"messages while still hook. Returns -1 if the channel was hung up.  If the\n"
-"file does not exist, will jump to priority n+101 if present.\n";
+"messages while still hook. If the file does not exist, will jump to priority n+101 if present.\n";
 
 STANDARD_LOCAL_USER;
 
index e411789..bfcbe7f 100755 (executable)
@@ -59,7 +59,7 @@ static char *descrip =
   "at least a 10 digit phone number, and if there exists a priority n + 101,\n"
   "where 'n' is the priority of the current instance, then  the\n"
   "channel  will  be  setup  to continue at that priority level.\n"
-  "Otherwise, it returns 0.  Does nothing if Caller*ID was received on the\n"
+  "Otherwise, the call is hungup.  Does nothing if Caller*ID was received on the\n"
   "channel.\n"
   "  Configuration file privacy.conf contains two variables:\n"
   "   maxretries  default 3  -maximum number of attempts the caller is allowed to input a callerid.\n"
index 1047d21..7fcffd7 100755 (executable)
@@ -125,9 +125,8 @@ static char *synopsis = "Queue a call for a call queue";
 static char *descrip =
 "  Queue(queuename[|options[|URL][|announceoverride][|timeout]]):\n"
 "Queues an incoming call in a particular call queue as defined in queues.conf.\n"
-"  This application returns -1 if the originating channel hangs up, or if the\n"
-"call is bridged and  either of the parties in the bridge terminate the call.\n"
-"Returns 0 if the queue is full, nonexistent, or has no members.\n"
+"This application will return to the dialplan if the queue does not exist, or\n"
+"any of the join options cause the caller to not enter the queue.\n"
 "The option string may contain zero or more of the following characters:\n"
 "      'd' -- data-quality (modem) call (minimum delay).\n"
 "      'h' -- allow callee to hang up by hitting *.\n"
@@ -156,7 +155,6 @@ static char *app_aqm_descrip =
 "Dynamically adds interface to an existing queue.\n"
 "If the interface is already in the queue and there exists an n+101 priority\n"
 "then it will then jump to this priority.  Otherwise it will return an error\n"
-"Returns -1 if there is an error.\n"
 "Example: AddQueueMember(techsupport|SIP/3000)\n"
 "";
 
@@ -167,7 +165,6 @@ static char *app_rqm_descrip =
 "Dynamically removes interface to an existing queue\n"
 "If the interface is NOT in the queue and there exists an n+101 priority\n"
 "then it will then jump to this priority.  Otherwise it will return an error\n"
-"Returns -1 if there is an error.\n"
 "Example: RemoveQueueMember(techsupport|SIP/3000)\n"
 "";
 
@@ -182,8 +179,8 @@ static char *app_pqm_descrip =
 "queuename is given, the interface is paused in every queue it is a\n"
 "member of.  If the interface is not in the named queue, or if no queue\n"
 "is given and the interface is not in any queue, it will jump to\n"
-" priority n+101, if it exists.  Returns -1 if the interface is not\n"
-"found and no extension to jump to exists, 0 otherwise.\n"
+" priority n+101, if it exists.  The application will fail if the interface is not\n"
+"found and no extension to jump to exists.\n"
 "Example: PauseQueueMember(|SIP/3000)\n";
 
 static char *app_upqm = "UnpauseQueueMember" ;
index bae0440..e024a5c 100755 (executable)
@@ -62,7 +62,7 @@ static char *descrip =
 "  attempts   -- if greater than 1, that many attempts will be made in the \n"
 "                event no data is entered.\n"
 "  timeout    -- if greater than 0, that value will override the default timeout.\n\n"
-"Returns -1 on hangup or error and 0 otherwise.\n";
+"Read should disconnect if the function fails or errors out.\n";
 
 STANDARD_LOCAL_USER;
 
index c856f34..31905a6 100755 (executable)
@@ -66,7 +66,8 @@ static char *descrip =
 "incremented by one each time the file is recorded. \n\n"
 "Use 'show file formats' to see the available formats on your system\n\n"
 "User can press '#' to terminate the recording and continue to the next priority.\n\n"
-"Returns -1 when the user hangs up.\n";
+"If the user should hangup during a recording, all data will be lost and the\n"
+"application will teminate. \n";
 
 STANDARD_LOCAL_USER;
 
index 1f92446..fc9cd25 100755 (executable)
@@ -54,8 +54,7 @@ static char *sayunixtime_descrip =
 "  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
 "              defaults to machine default.\n"
 "  format:   a format the time is to be said in.  See voicemail.conf.\n"
-"              defaults to \"ABdY 'digits/at' IMp\"\n"
-"  Returns 0 or -1 on hangup.\n";
+"              defaults to \"ABdY 'digits/at' IMp\"\n";
 static char *datetime_descrip =
 "DateTime([unixtime][|[timezone][|format]])\n"
 "  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
@@ -63,8 +62,7 @@ static char *datetime_descrip =
 "  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
 "              defaults to machine default.\n"
 "  format:   a format the time is to be said in.  See voicemail.conf.\n"
-"              defaults to \"ABdY 'digits/at' IMp\"\n"
-"  Returns 0 or -1 on hangup.\n";
+"              defaults to \"ABdY 'digits/at' IMp\"\n";
 
 STANDARD_LOCAL_USER;
 
index b0c9dc0..41ba1bb 100755 (executable)
@@ -48,9 +48,10 @@ static char *app = "SendDTMF";
 static char *synopsis = "Sends arbitrary DTMF digits";
 
 static char *descrip = 
-"  SendDTMF(digits[|timeout_ms]): Sends DTMF digits on a channel. \n"
-"  Accepted digits: 0-9, *#abcd\n"
-" Returns 0 on success or -1 on a hangup.\n";
+" SendDTMF(digits[|timeout_ms]): Sends DTMF digits on a channel. \n"
+" Accepted digits: 0-9, *#abcd\n"
+" The application will either pass the assigned digits or terminate if it\n"
+" encounters an error.\n";
 
 STANDARD_LOCAL_USER;
 
index 252c957..a8e3f24 100755 (executable)
@@ -59,8 +59,7 @@ static const char *descrip =
 "\n"
 "At this moment, text is supposed to be 7 bit ASCII in most channels.\n"
 "Old deprecated behavior: \n"
-" SendText only returns 0 if the text was sent correctly or if\n"
-" the channel does not support text transport.\n"
+" SendText should continue with the next priority upon successful execution.\n"
 " If the client does not support text transport, and there exists a\n"
 " step with priority n + 101, then execution will continue at that step.\n";
 
index 272d189..2d01ccf 100755 (executable)
@@ -50,7 +50,7 @@ LOCAL_USER_DECL;
 
 static char *descrip2 = 
 "  SetCallerPres(presentation): Set Caller*ID presentation on a call.\n"
-"  Always returns 0.  Valid presentations are:\n"
+"  Valid presentations are:\n"
 "\n"
 "      allowed_not_screened    : Presentation Allowed, Not Screened\n"
 "      allowed_passed_screen   : Presentation Allowed, Passed Screen\n" 
@@ -95,7 +95,7 @@ static char *synopsis = "Set CallerID";
 
 static char *descrip = 
 "  SetCallerID(clid[|a]): Set Caller*ID on a call to a new\n"
-"value.  Sets ANI as well if a flag is used.  Always returns 0\n";
+"value.  Sets ANI as well if a flag is used. \n";
 
 static int setcallerid_exec(struct ast_channel *chan, void *data)
 {
index 460bbc3..c477663 100755 (executable)
@@ -52,8 +52,7 @@ static char *setcdruserfield_descrip =
                "       can use for data not stored anywhere else in the record.\n"
                "       CDR records can be used for billing or storing other arbitrary data\n"
                "       (I.E. telephone survey responses)\n"
-               "       Also see AppendCDRUserField().\n"
-               "       Always returns 0\n";
+               "       Also see AppendCDRUserField().\n";
 
                
 static char *setcdruserfield_app = "SetCDRUserField";
@@ -68,8 +67,7 @@ static char *appendcdruserfield_descrip =
                "       can use for data not stored anywhere else in the record.\n"
                "       CDR records can be used for billing or storing other arbitrary data\n"
                "       (I.E. telephone survey responses)\n"
-               "       Also see SetCDRUserField().\n"
-               "       Always returns 0\n";
+               "       Also see SetCDRUserField().\n";
                
 static char *appendcdruserfield_app = "AppendCDRUserField";
 static char *appendcdruserfield_synopsis = "Append to the CDR user field";
index 41dfda7..2cb5896 100755 (executable)
@@ -51,7 +51,7 @@ static char *descrip =
 "  SetCIDName(cname[|a]): Set Caller*ID Name on a call to a new\n"
 "value, while preserving the original Caller*ID number.  This is\n"
 "useful for providing additional information to the called\n"
-"party. Always returns 0\n"
+"party. \n"
 "SetCIDName has been deprecated in favor of the function\n"
 "CALLERID(name)\n";
 
index d312944..95ea2c0 100755 (executable)
@@ -52,7 +52,7 @@ static char *descrip =
 "  SetCIDNum(cnum[|a]): Set Caller*ID Number on a call to a new\n"
 "value, while preserving the original Caller*ID name.  This is\n"
 "useful for providing additional information to the called\n"
-"party. Sets ANI as well if a flag is used.  Always returns 0\n"
+"party. Sets ANI as well if a flag is used.\n"
 "SetCIDNum has been deprecated in favor of the function\n"
 "CALLERID(number)\n";
 
index 992732b..f7f01c2 100755 (executable)
@@ -50,7 +50,7 @@ static char *synopsis = "Set RDNIS Number";
 
 static char *descrip = 
 "  SetRDNIS(cnum): Set RDNIS Number on a call to a new\n"
-"value.  Always returns 0\n"
+"value.\n"
 "SetRDNIS has been deprecated in favor of the function\n"
 "CALLERID(rdnis)\n";
 
index 5ee1ab8..5a9614a 100755 (executable)
@@ -58,7 +58,7 @@ static struct {       int val; char *name; } transcaps[] = {
 static char *descrip = 
 "  SetTransferCapability(transfercapability): Set the ISDN Transfer \n"
 "Capability of a call to a new value.\n"
-"Always returns 0.  Valid Transfer Capabilities are:\n"
+"Valid Transfer Capabilities are:\n"
 "\n"
 "  SPEECH             : 0x00 - Speech (default, voice calls)\n"
 "  DIGITAL            : 0x08 - Unrestricted digital information (data calls)\n"
index c6d4494..cf47d6d 100755 (executable)
@@ -67,8 +67,7 @@ static char *synopsis = "Communicates with SMS service centres and SMS capable a
 
 static char *descrip =
        "  SMS(name|[a][s]):  SMS handles exchange of SMS data with a call to/from SMS capabale\n"
-       "phone or SMS PSTN service centre. Can send and/or receive SMS messages.\n"
-       "Returns 0 if call handled correctly, or -1 if there were any problems.\n"
+       "phone or SMS PSTN service center. Can send and/or receive SMS messages.\n"
        "Works to ETSI ES 201 912 compatible with BT SMS PSTN service in UK\n"
        "Typical usage is to use to handle called from the SMS service centre CLI,\n"
        "or to set up a call using 'outgoing' or manager interface to connect\n"
index d8eb6f3..e9b0f24 100755 (executable)
@@ -44,7 +44,8 @@ static char *synopsis = "Soft Hangup Application";
 static char *tdesc = "Hangs up the requested channel";
 
 static char *desc = "  SoftHangup(Technology/resource|options)\n"
-"Hangs up the requested channel.  Always returns 0\n"
+"Hangs up the requested channel.  If there are no channels to hangup,\n"
+"the application will report it.\n"
 "- 'options' may contain the following letter:\n"
 "     'a' : hang up all channels on a specified device instead of a single resource\n";
 
index 8881057..e905394 100755 (executable)
@@ -44,8 +44,7 @@ static char *tdesc = "Strip trailing digits";
 static char *descrip =
 "  StripLSD(count): Strips the trailing  'count'  digits  from  the  channel's\n"
 "associated extension. For example, the  number  5551212 when stripped with a\n"
-"count of 4 would be changed to 555.  This app always returns 0, and the PBX\n"
-"will continue processing at the next priority for the *new* extension.\n"
+"count of 4 would be changed to 555.  The PBX will continue processing at the\n""next priority for the *new* extension.\n"
 "  So, for  example, if  priority 3 of 5551212  is  StripLSD 4, the next step\n"
 "executed will be priority 4 of 555.  If you switch into an  extension which\n"
 "has no first step, the PBX will treat it as though the user dialed an\n"
index c21c0ed..5d52169 100755 (executable)
@@ -55,8 +55,8 @@ static char *synopsis2 = "Try executing a system command";
 static char *chanvar = "SYSTEMSTATUS";
 
 static char *descrip =
-"  System(command): Executes a command  by  using  system(). Returns -1 on\n"
-"failure to execute the specified command. \n"
+"  System(command): Executes a command  by  using  system(). If the command\n"
+"fails, the console should report a fallthrough. \n"
 "Result of execution is returned in the SYSTEMSTATUS channel variable:\n"
 "   FAILURE    Could not execute the specified command\n"
 "   SUCCESS    Specified command successfully executed\n"
@@ -66,11 +66,10 @@ static char *descrip =
 "a priority n + 101, where 'n' is the priority of the current instance,\n"
 "then  the  channel  will  be  setup to continue at that priority level.\n"
 "Note that this jump functionality has been deprecated and will only occur\n"
-"if the global priority jumping option is enabled in extensions.conf.\n"
-" Otherwise, System returns 0.\n";
+"if the global priority jumping option is enabled in extensions.conf.\n";
 
 static char *descrip2 =
-"  TrySystem(command): Executes a command  by  using  system(). Returns 0\n"
+"  TrySystem(command): Executes a command  by  using  system().\n"
 "on any situation.\n"
 "Result of execution is returned in the SYSTEMSTATUS channel variable:\n"
 "   FAILURE    Could not execute the specified command\n"
@@ -80,7 +79,7 @@ static char *descrip2 =
 "Old behaviour:\nIf  the command itself executes but is in error, and if\n"
 "there exists a priority n + 101, where 'n' is the priority of the current\n"
 "instance, then  the  channel  will  be  setup  to continue at that\n"
-"priority level.  Otherwise, System returns 0.\n";
+"priority level.  Otherwise, System will terminate.\n";
 
 STANDARD_LOCAL_USER;
 
index 7f197ce..30e27e3 100755 (executable)
@@ -55,8 +55,7 @@ static char *descrip =
 "yet less than 'max' ms is followed by silence for at least 'sil' ms then\n"
 "the audio playback is aborted and processing jumps to the 'talk' extension\n"
 "if available.  If unspecified, sil, min, and max default to 1000, 100, and\n"
-"infinity respectively.  Returns -1 on hangup, and 0 on successful playback\n"
-"completion with no exit conditions.\n";
+"infinity respectively.\n";
 
 STANDARD_LOCAL_USER;
 
index f8532ff..6ed1e48 100755 (executable)
@@ -46,8 +46,7 @@ static char *verbose_synopsis = "Send arbitrary text to verbose output";
 
 static char *verbose_descrip =
 "Verbose([<level>|]<message>)\n"
-"  level must be an integer value.  If not specified, defaults to 0."
-"  Always returns 0.\n";
+"  level must be an integer value.  If not specified, defaults to 0.\n";
 
 STANDARD_LOCAL_USER;
 
index 975ffe5..c6c6f8a 100755 (executable)
@@ -308,8 +308,7 @@ static char *descrip_vm =
 "and there exists a priority n + 101, then that priority will be taken next.\n"
 "When multiple mailboxes are specified, the unavailable or busy message\n"
 "will be taken from the first mailbox specified.\n"
-"Returns -1 on error or mailbox not found, or if the user hangs up.\n"
-"Otherwise, it returns 0.\n";
+"Execution will fail if the mailbox does not exist, or if the user disconnects.\n";
 
 static char *synopsis_vmain =
 "Enter voicemail system";
index e3d55c0..00fb647 100755 (executable)
@@ -46,10 +46,10 @@ static char *synopsis = "Block telemarketers with SIT";
 
 static char *descrip = 
 "  Zapateller(options):  Generates special information tone to block\n"
-"telemarketers from calling you.  Returns 0 normally or -1 on hangup.\n"
-"Options is a pipe-delimited list of options.  The following options\n"
-"are available: 'answer' causes the line to be answered before playing\n"
-"the tone, 'nocallerid' causes Zapateller to only play the tone if there\n"
+"telemarketers from calling you.  Options is a pipe-delimited list of\n" 
+"options.  The following options are available:\n"
+"'answer' causes the line to be answered before playing the tone,\n" 
+"'nocallerid' causes Zapateller to only play the tone if there\n"
 "is no callerid information available.  Options should be separated by |\n"
 "characters\n";
 
index a361914..4a94f34 100755 (executable)
@@ -69,7 +69,7 @@ static char *descrip =
 "The channel must be a clear channel (i.e. PRI source) and a Zaptel\n"
 "channel to be able to use this function (No modem emulation is included).\n"
 "Your pppd must be patched to be zaptel aware. Arguments should be\n"
-"separated by | characters.  Always returns -1.\n";
+"separated by | characters.\n";
 
 STANDARD_LOCAL_USER;