home *** CD-ROM | disk | FTP | other *** search
/ CICA 1992 November / CICA_MS_Windows_CD-ROM_Walnut_Creek_November_1992.iso / win3 / misc / wcmacref.txt < prev    next >
Text File  |  1992-11-09  |  15KB  |  452 lines
  1. Macro Statement Reference Contents
  2.  
  3.  
  4. Clipboard Control
  5.  CLIPTOFILE(clipboard_type,filename)
  6.   Copies the Clipboard Text, Bitmap or Metafile to a disk file.
  7.  FILETOCLIP(clipbrd_type,file_name)
  8.   Copies a Windows metafile, bitmap or text file to the Clipboard.
  9.  PASTETEXT
  10.   Transmits and displays the text in the clipboard.
  11.  
  12. Conversion
  13.  INTTIME(hour,day,month,year)
  14.   Converts times and dates to the WinComm integer time/day value.
  15.  STRBIN(number)
  16.   Changes an integer number into a binary string representation of the number.
  17.  STRHEX(number)
  18.   Changes an integer number into a Hexedecimal string representation of the number.
  19.  STRINT(number)
  20.   Changes an integer number into a base 10 string representation of the number.
  21.  STROCT(number)
  22.   Changes an integer number into an Octal string representation of the number.
  23.  STRTIME(time)
  24.   Converts an integer time date value to a text string.
  25.  VALBIN(bin_text)
  26.   Converts a string of 1's and 0's in binary form to an integer value.
  27.  VALHEX(hex_text)
  28.   Converts a string representing a hex decimal number to an integer value.
  29.  VALINT(dec_text)
  30.   Converts a string representing a decimal number to an integer value.
  31.  VALOCT(oct_text)
  32.   Converts a string representing an octal number to an integer value.
  33.  
  34. Customizing
  35.  ALARM
  36.   Beeps the speaker.
  37.  
  38. Dialog Box Customizing
  39.  DIALOGBOX(left,top,width,height) and DEND
  40.   Used with the following items to create custom dialog boxes.
  41.  BEGINGROUP_RADIOBUTTON
  42.   The first radio button in a radiobutton group.
  43.  CANCELBUTTON
  44.   Defines the button that will be selected when the Esc key is pressed.
  45.  CHECKBOX
  46.   Displays a standard check box.
  47.  COMBOBOX
  48.   Displays a drop down list box for selection of an item from a list.
  49.  DEFCANCELBUTTON
  50.   Defines a Cancel button that will be selected when the Enter key is pressed.
  51.  DEFPUSHBUTTON
  52.   Defines the button that will be selected when the Enter key is pressed.
  53.  DESTROYDLG
  54.   Used to remove or destroy a Modeless Dialog Box
  55.  DIALOG?
  56.   Indicates the status of a dialog box.
  57.  DIRLISTBOX
  58.   Displays a list for selection of files, directories and drives.
  59.  DIRPATH
  60.   Displays the current path when used with the DIRLISTBOX.
  61.  EDITBOX
  62.   Used to create an edit box for text entry.
  63.  ENABLECTL(id,enabled)
  64.   Enables and disables Push Button and List Box styles
  65.  ENDGROUP_RADIOBUTTON
  66.   The last radiobutton in a radiobutton group.
  67.  FLISTBOX
  68.   Displays a list box for selection of an item from a large list.
  69.  GROUPBOX
  70.   Draws a black frame in a dialog box.
  71.  HELPID integer_id
  72.   Specifies the help topic to use with this dialog box.
  73.  LISTBOX
  74.   Displays a list box for selection of an item from a list.
  75.  LTEXT, CTEXT, RTEXT
  76.   Used to display static text in a dialog box.
  77.  PUSHBUTTON
  78.   Creates additional pushbuttons.
  79.  RADIOBUTTON
  80.   To create additional buttons in a radiobutton group.
  81.  SEDIT
  82.   Creates a file linked edit box with a vertical scroll bar for text entry.
  83.  STEXT
  84.   Creates a file linked text box with a vertical scroll bar.
  85.  UPDATEDLG(update_items)
  86.   Defines which variables are to be updated in a dialog box.
  87.  UPDATEPB
  88.   Updates variables in a dialog box.
  89.  VTEXT
  90.   Used to display a string variable in a dialog box.
  91.  
  92. DOS File Control
  93.  ADD(text)
  94.   Adds text to the capture file.
  95.  CHGDIR(directory_name)
  96.   Changes the current directory.
  97.  CHGDRIVE(drive_letter)
  98.   Changes the current drive.
  99.  COPYFILE(source_file,dest_file)
  100.   Copies a disk file.
  101.  DELETEFILE(file_name)
  102.   Deletes a disk file.
  103.  FCLOSE(file_no)
  104.   Closes a disk file.
  105.  FOPEN(open_mode,file_name)
  106.   Opens a disk file for information or for read/write operation.
  107.  FREAD(open_file,num_chars)
  108.   Returns a specified number of characters from a file.
  109.  FREADLN(open_file)
  110.   Returns a line of text from an open file.
  111.  FSEEK(open_file,offset,seek_type)
  112.   Positions a pointer in an open file for reading or writing.
  113.  FWRITE(open_file,chars,text)
  114.   Writes a string of text to an open file.
  115.  FWRITELN(open_file,text)
  116.   Writes a line of text to an open file.
  117.  MKDIR(dir_name)
  118.   Used to create a new disk directory.
  119.  RENAME(old_name,new_name)
  120.   Renames a file.
  121.  RMDIR(dir_name)
  122.   Removes a directory.
  123.  SETFILEATTR(attribute,file_name)
  124.   Sets a file attribute.
  125.  SETFILEDATE(date_time,file_name)
  126.   Sets a files date and time.
  127.  
  128. DOS File Information
  129.  CURDIR?
  130.   Returns the name of the current directory.
  131.  CURDRIVE?
  132.   Returns the name of the current disk drive.
  133.  FILEATTRIBUTE(file_name)
  134.   Used to obtain the attributes of a file.
  135.  FILEFIND(file_name,attributes)
  136.   Finds the first file meeting name and attribute requirements.
  137.  FILESIZE(open_file)
  138.   Returns the size of a file.
  139.  FILETIME(open_file)
  140.   Returns the creation or last modification date of a file.
  141.  FINDNEXT
  142.   Finds the next file that meets the criteria set up by FILEFIND.
  143.  
  144. DOS Information
  145.  DOSVER?
  146.   Returns the version of DOS.
  147.  ENVIRON
  148.   Returns information about the current DOS environment.
  149. Dynamic Data Exchange
  150.  DDEADVISE(chan_no,my_var$,server_var)
  151.   Requests the server application to send the value of a variable to WinComm each time it changes.
  152.  DDEEXEC(chan_no,"execute_text")
  153.   Executes commands  in the server application.
  154.  DDEINIT(app_name,doc_name)
  155.   Requests the server application to establish a DDE channel for data exchanges or control.
  156.  DDEPOKE(chan_no,server_var,my_var$)
  157.   Sends data to the server application.
  158.  DDEREQ(chan_no,my_var,server_var)
  159.   Obtains the current value of a variable from the server application.
  160.  DDETERM(chan_no)
  161.   Terminates the DDE link or channel established with the server using DDEINIT.
  162.  DDEUNADVISE(chan_no,server_var)
  163.   Terminates an advise which was established by using DDEADVISE.
  164.  
  165. Graphics Customizing
  166.  BITBKG(h_pos,v_pos,from,file_name)
  167.   Displays a bitmap background in the user window.
  168.  DELOBJECT(type,start_id,end_id)
  169.   Used to remove different items of a graphic display.
  170.  METABKG(h_pos,v_pos,mapping,file_name)
  171.   Displays a metafile background in the user window.
  172.  USERWINDOW(pos,size_ref,size,bkg_color)
  173.   Used to define an area of the WinComm window for display of graphics.
  174.  
  175. Graphics Menus
  176.  BITMAP(left,top,id,text,file_name)
  177.   Places a bitmap icon on the background graphic.
  178.  BUTTON(left,top,width,height,"id,text")
  179.   Places a Windows push button on the background graphic.
  180.  HOTSPOT(left,top,right,bot,id)
  181.   Places a mouse selectable spot on the background graphic.
  182.  METAFILE(left,top,right,bot,file_name)
  183.   Places a metafile on the background graphic.
  184.  OBJECT?
  185.   Returns information about selection of objects on a graphic display screen.
  186.  
  187. Macro Control
  188.  CHAIN(macro_name)
  189.   Transfers macro execution to another macro.
  190.  CHAINRETURN
  191.   Transfers macro execution back to the calling macro.
  192.  END
  193.   Indicates the logical end of a macro.
  194.  GOSUB label
  195.   Transfers execution of the macro to a subroutine.
  196.  GOTO label
  197.   Transfers execution of the macro to a label.
  198.  HALT
  199.   Stops the in-line execution of the macro.
  200.  MACROHALT(greyed)
  201.   Used to disable the Macro check box on the WinComm command bar.
  202.  MACROTRAP(enabled)
  203.   Routes all characters received on the communication port to the macro.
  204.  PROMPT and PEND and PROMPT?
  205.   Allows testing of the communication port and input strings.
  206.   The following statements are used in a prompt statement group:
  207.    PCOUNT(id,#char)
  208.     Tests for the number of characters received on communication port.
  209.    PDCD(id)
  210.     Test the status of the Data Carrier Detect modem signal.
  211.    PKEY(id,char_code)
  212.     Tests for a character typed on the keyboard.
  213.    PQUIET(is,10ths_sec)
  214.     Tests for quiet time on communication port.
  215.    PSTR(type,id,char_str)
  216.     Tests for a string received on the communication port.
  217.    PWAIT(id,10ths_sec)
  218.     Waits for a specified period of time.
  219.  RETURN
  220.   Used to denote the logical end of a subroutine.
  221.  RSTACK
  222.   Used to reset the subroutine stack pointer.
  223.  SEND(text)
  224.   Transmits text to the communication port.
  225.  STEP
  226.   Used to break execution in a running macro to allow debugging.
  227.  
  228. Macro Evaluation
  229.  IF(logical_experession)
  230.   Used to make branching decisions based on values of input variables.
  231.  ELSE
  232.   Used with the IF statement to group a number of statements
  233.  DO
  234.   Used with UNTIL to begin a looping operation.
  235.  UNTIL(logical_expression)
  236.   Ends a DO loop statement group.
  237.  WHILE(logical_expression)
  238.   Performs a statement or statement group while a condition is true.
  239.  WEND
  240.   Ends a WHILE statement group.
  241.  
  242. Macro Variable Control
  243.  GETGLOBALINT(integer_number)
  244.   Used to pass strings between chained macros.
  245.  GETGLOBALSTR(string_number)
  246.   Used to pass integers between chained macros.
  247.  PUTGLOBALINT(integer_number,value)
  248.   Passes numbers to macros that will be chained to.
  249.  PUTGLOBALSTR(string_number,text)
  250.   Passes strings to macros that will be chained to.
  251.  RESTOREVARS
  252.   Restores a macro's variables after a CHAINRETURN.
  253.  SAVEVARS
  254.   Saves macro variables for a CHAINRETURN from another macro.
  255.  
  256. Math
  257.  ABS(value)
  258.   Gives the absolute value of the integer argument.
  259.  CHKSUM
  260.   Calculates the checksum of a string.
  261.  CRC
  262.   Calculates the CRC of a string.
  263.  
  264. Menu Customizing
  265.  ADDBAR
  266.   Adds a menu bar to the WinComm menu bar set.
  267.  ADDCOMMAND(menu_number,menu_id,menu_text)
  268.   Adds a command to a pop-up menu item.
  269.  ADDMENU(bar_number,menu_text)
  270.   Adds a menu to the Menu Bar.
  271.  ENABLEMENU(menu_bar,id,greyed)
  272.   Used to enable and disable individual menu items.
  273.  HELP(help_file)
  274.   Identifies the custom context sensitive help file.
  275.  MENU?
  276.   Returns the value of the selected menu item.
  277.  MENUBAR?
  278.   Returns an identifier for the current menu bar.
  279.  SHOWBAR(bar_number)
  280.   Displays a new or changed menu bar.
  281.  
  282. Session Variable Control
  283.  ACTIVATESESS
  284.   Activates changes made to session variables.
  285.  GETSESSINT(int_id)
  286.   Used to return the currently loaded integer session variable.
  287.  GETSESSSTR(string_id)
  288.   Used to return the currently loaded string session variable.
  289.  PUTSESSINT(int_id,int_value)
  290.   Used to assign values to any session integer.
  291.  PUTSESSSTR(string_id,string_value)
  292.   Used to assign values to any session string.
  293.  
  294. Stock Dialog Box
  295.  ALERT(text)
  296.   Displays a stock dialog box with text and an OK button.
  297.  ALERTCANCEL(text)
  298.   Displays text in a stock dialog box with OK and Cancel buttons.
  299.  FILEOPENDLG(head_txt,ext,return_txt)
  300.   Displays a stock dialog box for selecting a file.
  301.  INPUTDLG(input_txt,heading_txt)
  302.   Displays a stock dialog box for input.
  303.  SAVEASDLG(heading_text,def_filename)
  304.   Displays a stock dialog box used to name a file before it is saved.
  305.  
  306. System Information
  307.  TIME?
  308.   Returns the current system time in integer format.
  309.  
  310. Text
  311.  ASC(text)
  312.   Returns the decimal value of an ASCII character.
  313.  BITSTRIP(text)
  314.   Sets the high order bit in text to 0.
  315.  CHAR(ascii_value)
  316.   Returns an ASCII character from a decimal value.
  317.  CLEAN(text)
  318.   Removes non-printing ASCII characters from a string.
  319.  CMP(str1,str2)
  320.   Compares 2 text strings.
  321.  DELETE(text,beg_pos,num_char)
  322.   Removes text from a string
  323.  EXTRACT(bracket_text,text,inst_no)
  324.   Extracts a substring from a text string.
  325.  LEFT(text,num_chars)
  326.   Returns a number of characters from the left portion of a string.
  327.  LEN(text)
  328.   Returns the length of a string.
  329.  LOWERCASE(text)
  330.   Converts text to lower case.
  331.  LPRINT(text)
  332.   Sends a line of text to the printer.
  333.  MID(text,first_char,num_chars)
  334.   Returns characters from the middle portion of a string.
  335.  NEXTCHAR?
  336.   Returns the next character in the receive buffer.
  337.  NULL(text)
  338.   Tests to see if a string is null.
  339.  PRINT(text)
  340.   Displays characters in the WinComm window text area.
  341.  QUOTE(text)
  342.   Puts a string in quotation marks.
  343.  RIGHT(text,num_chars)
  344.   Returns a number of characters from the right end of a string.
  345.  SEARCH(substr,str)
  346.   Finds the occurrence of a string in another string.
  347.  SUBST(orig_txt,find_txt,replace_txt,times)
  348.   Substitutes text for other text in a string.
  349.  UPPERCASE(text)
  350.   Returns a string as all upper case characters.
  351.  
  352. WinComm Command
  353.  ACTIVATE
  354.   Activates the instance of WinComm running this macro.
  355.  CAPTURE(cont)
  356.   Controls the capture feature of WinComm.
  357.  CLEAR
  358.   Clears the WinComm screen and display buffer.
  359.  CLOSE
  360.   Exits WinComm
  361.  DIAL(tele_number)
  362.   Dials a telephone number.
  363.  DISABLE(logical)
  364.   Used to disable selection of menu items and dialog box controls.
  365.  PRINTER(cont)
  366.   Turns the printer on and off.
  367.  SHOW(change)
  368.   Repaints the WinComm window for graphics display.
  369.  START
  370.   Starts the currently loaded session.
  371.  STATUSLINE(status_text)
  372.   Places text in the status line.
  373.  STOP
  374.   Stops the currently loaded session.
  375.  WINMOVE(left,top,width,height)
  376.   Sizes and positions the WinComm Window.
  377.  
  378. WinComm DLL
  379.  CALL(dll.fil|process,str1,str2,int1,int2)
  380.   Calls a dynamically linked library from within a WinComm macro.
  381.  
  382. WinComm File Control
  383.  NEW
  384.   Loads default WinComm session settings.
  385.  OPEN(session_file_name,pswrd,mode)
  386.   Opens a WinComm session file.
  387.  SAVEAS(file_name)
  388.   Saves the current session file using file_name.
  389.  
  390. WinComm File Transfer
  391.  RECEIVEASCII(diag_disp,file_name)
  392.   Sets WinComm up to receive an ASCII file.
  393.  SENDASCII(diag_disp,file_name)
  394.   Sends an ASCII file using the settings assigned in the current session.
  395.  XFER?
  396.   Variable used to determine the status of a file transfer.
  397.  
  398. WinComm Information
  399.  ACTIVE?
  400.   Indicates if WinComm is active.
  401.  ONLINE?
  402.   Tests to see if a WinComm session has been started.
  403.  STATUSLINE?
  404.   Returns the text displayed on the status line.
  405.  WINCOMMVER?
  406.   Gives the version of WinComm.
  407.  
  408. WinComm Packet Data Transfer
  409.  PKTIME(trans_time,rec_time)
  410.   Used to set the timing for packet transmission and reception.
  411.  RXPKT(cmd,rec_str)
  412.   Receives an error-free string of data from another macro using the TXPKT command.
  413.  TXPKT(cmd,xmit_str)
  414.   Sends an error-free string to another macro using RXPKT statement.
  415.  TXPKTSTAT?
  416.   The variable that indicates the status of a packet protocol transfer.
  417.  
  418. WinComm Protocol File Transfer
  419.  RECEIVEFILE(diag_disp,file_name)
  420.   Sets WinComm up to receive a file using an error-correcting protocol.
  421.  SENDFILE(diag_disp,file_name)
  422.   Sends a file using an error-free protocol assigned in the current session.
  423.  
  424. WinComm/WinLink File Control
  425.  PCTOPC(cmd,opt,text)
  426.   Used to control file operations of another computer via the serial communication link.
  427.  
  428. Windows Application Control
  429.  APPACTIVATE(title_bar_text)
  430.   Activates a loaded Windows application.
  431.  RUN(app_name,cmd_line,size)
  432.   Used to start another Windows application.
  433.  SENDKEY(key_text)
  434.   Sends normal ASCII characters to the active Windows application.
  435.  SENDSPECKEY(ctrl,key1_val,key2_val)
  436.   Sends non-printing and combinations of non-printing and printing characters to the active Windows application.
  437.  SETFOCUS(id)
  438.   Sets the focus to a given window or control within a Windows application.
  439.  
  440. Windows File Control
  441.  SYSTEM
  442.   Saves system information in the WIN.INI file.
  443.  FREEMEM?
  444.   Returns the number of bytes of Windows free memory.
  445.  GETFOCUS?
  446.   Returns an identifier of the window that has the input focus.
  447.  GETSCRAP(value_id)
  448.   Returns information about the Windows display screen.
  449.  WINVER?
  450.   Gives the version of Windows.
  451.  
  452.