[Gd-chatter] r11220 - in trunk/documentation/gwydion/gdcore: . text
agent at gwydiondylan.org
agent at gwydiondylan.org
Fri Mar 2 06:28:03 CET 2007
Author: agent
Date: Fri Mar 2 06:27:46 2007
New Revision: 11220
Modified:
trunk/documentation/gwydion/gdcore/README
trunk/documentation/gwydion/gdcore/text/module.operating-system.system.txt
trunk/documentation/gwydion/gdcore/text/name.Darchitecture-little-endianQ.txt
trunk/documentation/gwydion/gdcore/text/name.Dmachine-name.txt
trunk/documentation/gwydion/gdcore/text/name.Dos-name.txt
trunk/documentation/gwydion/gdcore/text/name.Dos-variant.txt
trunk/documentation/gwydion/gdcore/text/name.Dos-version.txt
trunk/documentation/gwydion/gdcore/text/name.Dplatform-name.txt
trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt
trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt
trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt
trunk/documentation/gwydion/gdcore/text/name.LstringR.txt
trunk/documentation/gwydion/gdcore/text/name.application-arguments.txt
trunk/documentation/gwydion/gdcore/text/name.application-filename.txt
trunk/documentation/gwydion/gdcore/text/name.application-name.txt
trunk/documentation/gwydion/gdcore/text/name.command-line-option-prefix.txt
trunk/documentation/gwydion/gdcore/text/name.create-application-event.txt
trunk/documentation/gwydion/gdcore/text/name.environment-variable-setter.txt
trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt
trunk/documentation/gwydion/gdcore/text/name.exit-application.txt
trunk/documentation/gwydion/gdcore/text/name.load-library.txt
trunk/documentation/gwydion/gdcore/text/name.login-group.txt
trunk/documentation/gwydion/gdcore/text/name.login-name.txt
trunk/documentation/gwydion/gdcore/text/name.owner-name.txt
trunk/documentation/gwydion/gdcore/text/name.owner-organization.txt
trunk/documentation/gwydion/gdcore/text/name.run-application.txt
trunk/documentation/gwydion/gdcore/text/name.signal-application-event.txt
trunk/documentation/gwydion/gdcore/text/name.tokenize-environment-variable.txt
trunk/documentation/gwydion/gdcore/text/name.wait-for-application-event.txt
Log:
Bug: 7344
Document the operating-system module.
Modified: trunk/documentation/gwydion/gdcore/README
==============================================================================
--- trunk/documentation/gwydion/gdcore/README (original)
+++ trunk/documentation/gwydion/gdcore/README Fri Mar 2 06:27:46 2007
@@ -336,13 +336,20 @@
make on superclasses
define class
-For the functions on the class, list all functions with an argument of the
-class's type, or a type-union, limited, or subclass involving the class. If a
-function takes <object> but actually expects <my-class>, include it under
-<my-class> and not <object>. Do not include functions on superclasses, or
-every "Functions on" list will look like the one for <object>.
+For the functions on the class or returning the class, list all functions with
+an argument or value of the class's type, or a type-union, limited, or
+subclass involving the class. The skeletal docs will often have this wrong.
+
+In particular, functions that return or take a type-union, limited, or
+subclass type aren't correctly categorized. A function returning
+type-union(<integer>, <string>), for example, should be listed under both the
+<integer> and <string> classes.
-For the functions returning the class, likewise.
+If a function takes <object> but actually expects <my-class>, include it under
+<my-class> and not <object>.
+
+Do not include functions on or returning superclasses, or every "Functions on"
+list will look like the one for <object>.
============================
Modified: trunk/documentation/gwydion/gdcore/text/module.operating-system.system.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/module.operating-system.system.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/module.operating-system.system.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,18 @@
Module: Module operating-system
==============================
-The operating-system module.
+The operating-system module contains functions for dealing with environment
+variables, the current user, and processes.
+
+Note that the following functions are only effective under Windows operating
+systems:
+
+- #owner-name#
+- #owner-organization#
+- #create-application-event#
+- #wait-for-application-event#
+- #signal-application-event#
+- #load-library#
Exported from:
Modified: trunk/documentation/gwydion/gdcore/text/name.Darchitecture-little-endianQ.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Darchitecture-little-endianQ.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Darchitecture-little-endianQ.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,9 @@
Constant: $architecture-little-endian?
==============================
-A constant.
+A constant indicating the endianness of a given build of Gwydion Dylan. If
+built on a little-endian machine, the value of this variable will be #t,
+otherwise, #f.
Exported from:
@@ -11,10 +13,10 @@
Type:
------------------------------
-#<object>#
+#<boolean>#
Value:
------------------------------
-#f
+platform-specific
Modified: trunk/documentation/gwydion/gdcore/text/name.Dmachine-name.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Dmachine-name.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Dmachine-name.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Constant: $machine-name
==============================
-A constant.
+A constant indicating the target CPU of a given build of Gwydion Dylan.
+Values include #"powerpc" and #"x86".
Exported from:
@@ -11,10 +12,10 @@
Type:
------------------------------
-#<object>#
+#<symbol>#
Value:
------------------------------
-#"powerpc"
+platform-specific
Modified: trunk/documentation/gwydion/gdcore/text/name.Dos-name.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Dos-name.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Dos-name.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,9 @@
Constant: $os-name
==============================
-A constant.
+A constant indicating the current OS. For Microsoft Windows, the value is
+#"win32"; for Unix operating systems, the value of this constant is determined
+at run-time from the uname function.
Exported from:
@@ -11,10 +13,10 @@
Type:
------------------------------
-#<object>#
+#<symbol>#
Value:
------------------------------
-unknown
+platform-specific
Modified: trunk/documentation/gwydion/gdcore/text/name.Dos-variant.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Dos-variant.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Dos-variant.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,18 @@
Constant: $os-variant
==============================
-A constant.
+A constant indicating the current OS variation. For Unix operating systems,
+the value is identical to #$os-name#. For Microsoft Windows operating systems,
+the value of this constant is determined at run-time and includes the
+following:
+
+- #"win3.1"
+- #"win95"
+- #"win98"
+- #"winme"
+- #"winnt"
+- #"win2000"
+- #"winxp"
Exported from:
@@ -11,10 +22,10 @@
Type:
------------------------------
-#<object>#
+#<symbol>#
Value:
------------------------------
-unknown
+platform-specific
Modified: trunk/documentation/gwydion/gdcore/text/name.Dos-version.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Dos-version.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Dos-version.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,9 @@
Constant: $os-version
==============================
-A constant.
+A constant indicating the version of the current OS. The value is determined
+at run-time from the uname (for Unix) or GetVersionExA (for Windows)
+functions.
Exported from:
@@ -16,5 +18,5 @@
Value:
------------------------------
-unknown
+platform-specific
Modified: trunk/documentation/gwydion/gdcore/text/name.Dplatform-name.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Dplatform-name.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Dplatform-name.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Constant: $platform-name
==============================
-A constant.
+A constant indicating the CPU and OS. This constant is set to the combination
+of #$machine-name# and #$os-name#, for example, #"x86-win32" or #"powerpc-Darwin".
Exported from:
@@ -11,10 +12,10 @@
Type:
------------------------------
-#<object>#
+#<symbol>#
Value:
------------------------------
-unknown
+platform-specific
Modified: trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt Fri Mar 2 06:27:46 2007
@@ -38,6 +38,7 @@
- #print#
- #print-to-string#
- #regexp-matches#
+- #run-application#
- #split#
Modified: trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lbyte-stringR.txt Fri Mar 2 06:27:46 2007
@@ -47,6 +47,8 @@
Functions returning <byte-string>:
------------------------------
- #application-name#
+- #environment-variable#
+- #environment-variable-setter#
- #import-string#
- #join#
Modified: trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LfunctionR.txt Fri Mar 2 06:27:46 2007
@@ -80,6 +80,7 @@
- #reduce-l#
- #reduce-r#
- #replace-elements!#
+- #run-application#
- #satisfies#
- #sequence-hash#
- #tabulate#
Modified: trunk/documentation/gwydion/gdcore/text/name.LstringR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LstringR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LstringR.txt Fri Mar 2 06:27:46 2007
@@ -80,6 +80,7 @@
Functions returning <string>:
------------------------------
+- #application-filename#
- #as-iso8601-string#
- #condition-format-string#
- #float-to-string#
@@ -88,10 +89,14 @@
- #local-time-zone-name#
- #locator-as-string#
- #locator-protocol#
+- #login-group#
+- #login-name#
- #machine-word-to-string#
- #number-to-string#
- #option-description#
- #option-description-setter#
+- #owner-name#
+- #owner-organization#
- #print-to-string#
- #regexp-replace#
- #split#
Modified: trunk/documentation/gwydion/gdcore/text/name.application-arguments.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.application-arguments.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.application-arguments.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: application-arguments
==============================
-A function.
+Returns an application's command-line arguments; in C terms, argv[1..n].
Exported from:
@@ -13,7 +13,8 @@
Values:
------------------------------
-val - An instance of #<simple-object-vector>#.
+strings - An instance of #<simple-object-vector>#. Each element is a
+ #<string>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.application-filename.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.application-filename.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.application-filename.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: application-filename
==============================
-A function.
+Returns an application's filename.
Exported from:
@@ -13,7 +13,8 @@
Values:
------------------------------
-val - An instance of type-union(<false>, <string>).
+filename - An instance of type-union(<false>, <string>). If the filename can't
+ be determined, the value is #f.
Modified: trunk/documentation/gwydion/gdcore/text/name.application-name.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.application-name.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.application-name.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Function: application-name
==============================
-A function.
+The name of the application as specified on the command line; in C terms,
+argv[0].
Exported from:
@@ -13,7 +14,7 @@
Values:
------------------------------
-val - An instance of #<byte-string>#.
+name - An instance of #<byte-string>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.command-line-option-prefix.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.command-line-option-prefix.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.command-line-option-prefix.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,9 @@
Function: command-line-option-prefix
==============================
-A function.
+Returns the character that traditionally indicates a command-line option.
+Under Microsoft Windows, this will be '/'. Under a Unix-based operating
+system, this will be '-'.
Exported from:
@@ -11,7 +13,7 @@
Values:
------------------------------
-val - An instance of #<character>#.
+prefix - An instance of #<character>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.create-application-event.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.create-application-event.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.create-application-event.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Function: create-application-event
==============================
-A function.
+A function that creates an event handle suitable for inter-thread
+synchronization.
Exported from:
@@ -11,12 +12,15 @@
Arguments:
------------------------------
-arg - An instance of #<string>#.
+name - An instance of #<string>#. A name for the event.
Values:
------------------------------
-val - An instance of #<machine-word>#.
-
+handle - An instance of #<machine-word>#. An event handle.
+See also:
+------------------------------
+- #signal-application-event#
+- #wait-for-application-event#
Modified: trunk/documentation/gwydion/gdcore/text/name.environment-variable-setter.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.environment-variable-setter.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.environment-variable-setter.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: environment-variable-setter
==============================
-A function.
+Sets the value of an environment variable.
Exported from:
@@ -11,13 +11,16 @@
Arguments:
------------------------------
-arg - An instance of type-union(<false>, <byte-string>).
-arg - An instance of #<byte-string>#.
+value - An instance of #<byte-string>#, or #f to remove the environment
+ variable from the environment.
+name - An instance of #<byte-string>#. The name of an environment variable.
Values:
------------------------------
-val - An instance of type-union(<false>, <byte-string>).
-
+value - The same _value_ passed as an argument.
+See also:
+------------------------------
+#environment-variable#
Modified: trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.environment-variable.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: environment-variable
==============================
-A function.
+Returns the value of an environment variable.
Exported from:
@@ -11,12 +11,15 @@
Arguments:
------------------------------
-arg - An instance of #<byte-string>#.
+name - An instance of #<byte-string>#.
Values:
------------------------------
-val - An instance of type-union(<false>, <byte-string>).
-
+value - An instance of #<byte-string>#, or #f if the environment variable
+ _name_ does not exist.
+See also:
+------------------------------
+#environment-variable-setter#
Modified: trunk/documentation/gwydion/gdcore/text/name.exit-application.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.exit-application.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.exit-application.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Function: exit-application
==============================
-A function.
+Causes the application to quit with a return code of _exit-code_. This
+function simply calls #exit#.
Exported from:
@@ -13,7 +14,7 @@
Arguments:
------------------------------
-arg - An instance of #<integer>#.
+exit-code - An instance of #<integer>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.load-library.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.load-library.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.load-library.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Function: load-library
==============================
-A function.
+Loads a dynamic library into the application's memory space. See the Win32
+function _LoadLibrary_.
Exported from:
@@ -11,12 +12,13 @@
Arguments:
------------------------------
-arg - An instance of #<string>#.
+name - An instance of #<string>#. The path and filename of the library.
Values:
------------------------------
-val - An instance of #<object>#.
+module - An instance of #<object>#. A handle to the loaded library, if
+ successful.
Modified: trunk/documentation/gwydion/gdcore/text/name.login-group.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.login-group.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.login-group.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,9 @@
Function: login-group
==============================
-A function.
+Returns the group of the currently logged-in user account. Under Windows, this
+is the account's domain name. Under Unix, this is the name of the account's
+GID.
Exported from:
@@ -11,7 +13,11 @@
Values:
------------------------------
-val - An instance of type-union(<false>, <string>).
+group - An instance of #<string>#, or #f if unable to determine the group or
+ domain.
+See also:
+------------------------------
+#login-name#
Modified: trunk/documentation/gwydion/gdcore/text/name.login-name.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.login-name.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.login-name.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: login-name
==============================
-A function.
+Returns the name of the currently logged-in user account.
Exported from:
@@ -11,7 +11,10 @@
Values:
------------------------------
-val - An instance of type-union(<false>, <string>).
-
+name - An instance of #<string>#, or #f if the account name could not be
+ determined.
+See also:
+------------------------------
+#login-group#
Modified: trunk/documentation/gwydion/gdcore/text/name.owner-name.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.owner-name.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.owner-name.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: owner-name
==============================
-A function.
+Returns the registered owner's name.
Exported from:
@@ -11,7 +11,8 @@
Values:
------------------------------
-val - An instance of type-union(<false>, <string>).
+name - An instance of #<string>#, or #f if the registered owner's name could
+ not be determined.
Modified: trunk/documentation/gwydion/gdcore/text/name.owner-organization.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.owner-organization.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.owner-organization.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: owner-organization
==============================
-A function.
+Returns the registered owner's organization
Exported from:
@@ -11,7 +11,6 @@
Values:
------------------------------
-val - An instance of type-union(<false>, <string>).
-
-
+org - An instance of #<string>#, or #f if the registered owner's organization
+ could not be determined.
Modified: trunk/documentation/gwydion/gdcore/text/name.run-application.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.run-application.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.run-application.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,14 @@
Function: run-application
==============================
-A function.
+Runs an application in a separate process. Under Windows, the application's
+output may be retrieved piecemeal via the _outputter_ argument.
+
+The _outputter_ argument is a function with the signature
+(buffer :: #<byte-string>#, end: :: #<integer>#) => ().
+It is called repeatedly with output from the process. _buffer_ contains the
+output, and _end_ indicates the extent of _buffer_ that contains the output.
+The contents of _buffer_ are not preserved between invocations of _outputter_.
Exported from:
@@ -9,15 +16,38 @@
- #Module operating-system#
-Arguments:
+Arguments (Windows):
+------------------------------
+command - An instance of #<string>#. A shell command line.
+
+under-shell?: - An instance of #<boolean>#, specifying whether to execute
+ the command line in a new shell. Defaults to #f.
+
+inherit-console?: - An instance of #<boolean>#, specifying whether the new
+ process should inherit existing handles. Defaults to #t.
+
+activate?: - An instance of #<boolean>#, specifying whether to bring
+ the new process's window to the foreground. Defaults to
+ #t.
+
+minimize?: - An instance of #<boolean>#, specifying whether to minimize
+ the new process's window. Defaults to #f.
+
+outputter: - An instance of #<function># or #f. A function to deal with
+ the process's output.
+
+asynchronous?: - An instance of #<boolean>#. If false, wait for the process
+ to terminate before continuing execution. Defaults to #f.
+
+
+Arguments (Unix):
------------------------------
-arg - An instance of #<string>#.
-#all-keys - This function accepts any keyword argument.
+command - An instance of #<string>#. A shell command line.
Values:
------------------------------
-val - An instance of #<integer>#.
+status-code - An instance of #<integer>#. The application's exit status code.
Modified: trunk/documentation/gwydion/gdcore/text/name.signal-application-event.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.signal-application-event.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.signal-application-event.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: signal-application-event
==============================
-A function.
+A function that signals an event created by #create-application-event#.
Exported from:
@@ -11,12 +11,15 @@
Arguments:
------------------------------
-arg - An instance of #<string>#.
+name - An instance of #<string>#. The name of the event to signal.
Values:
------------------------------
-val - An instance of #<boolean>#.
-
+success? - An instance of #<boolean>#.
+See also:
+------------------------------
+- #create-application-event#
+- #wait-for-application-event#
Modified: trunk/documentation/gwydion/gdcore/text/name.tokenize-environment-variable.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.tokenize-environment-variable.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.tokenize-environment-variable.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,8 @@
Function: tokenize-environment-variable
==============================
-A function.
+Splits an PATH-type environment variable into individual values. On Windows,
+the variable is split around ';'. On Unix, the variable is split around ':'.
Exported from:
@@ -11,12 +12,13 @@
Arguments:
------------------------------
-arg - An instance of #<string>#.
+var - An instance of #<string>#. The value of an environment variable.
Values:
------------------------------
-val - An instance of #<sequence>#.
+strings - An instance of #<sequence># containing #<string>#s. Each path or
+ filename in _var_.
Modified: trunk/documentation/gwydion/gdcore/text/name.wait-for-application-event.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.wait-for-application-event.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.wait-for-application-event.txt Fri Mar 2 06:27:46 2007
@@ -1,7 +1,7 @@
Function: wait-for-application-event
==============================
-A function.
+Halt the current thread until an event is signaled or a timeout expires.
Exported from:
@@ -11,13 +11,17 @@
Arguments:
------------------------------
-arg - An instance of #<machine-word>#.
-timeout: - An instance of #<integer>#. The default is -1.
+handle - An instance of #<machine-word>#. The event handle.
+timeout: - An instance of #<integer>#. If not supplied, the timeout is
+ infinite.
Values:
------------------------------
-val - An instance of #<boolean>#.
-
+success? - An instance of #<boolean>#. True if the event was signaled.
+See also:
+------------------------------
+- #create-application-event#
+- #signal-application-event#
More information about the chatter
mailing list