$Unbind and $UnbindW: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 4: | Line 4: | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no OO equivalents for the $Unbind and $UnbindW functions.</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no OO equivalents for the $Unbind and $UnbindW functions.</p> | ||
The $Unbind and $UnbindW functions unbind resources previously bound with the $Bind function. | The $Unbind and $UnbindW functions unbind resources previously bound with the [[$Bind]] function. | ||
$Unbind and $UnbindW accept one argument and return a numeric code. | $Unbind and $UnbindW accept one argument and return a numeric code. | ||
| Line 15: | Line 15: | ||
</p> | </p> | ||
<p class="caption">%RESULT is set to indicate the success of the function.</p> | <p class="caption">%RESULT is set to indicate the success of the function.</p> | ||
<p class="code"> | <p class="code"> | ||
0 - Resource successfully unbound | 0 - Resource successfully unbound | ||
| Line 22: | Line 23: | ||
<p class="caption">$Unbind return codes | <p class="caption">$Unbind return codes | ||
</p> | </p> | ||
<p class="code"> | <p class="code"> | ||
%RESULT = $UnbindW(res_name) | %RESULT = $UnbindW(res_name) | ||
Revision as of 20:59, 8 February 2011
<section begin="desc" />$Unbind and $UnbindW: Unbind resource previously bound via $Bind<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no OO equivalents for the $Unbind and $UnbindW functions.
The $Unbind and $UnbindW functions unbind resources previously bound with the $Bind function.
$Unbind and $UnbindW accept one argument and return a numeric code.
The only argument is the name of the resource to be unbound. This resource name can be any string up to 255 bytes long.
Syntax
<section begin="syntax" /> %RESULT = $Unbind(res_name) <section end="syntax" />
$Unbind Function
%RESULT is set to indicate the success of the function.
0 - Resource successfully unbound 1 - Resource name missing 2 - User does not have resource bound
$Unbind return codes
%RESULT = $UnbindW(res_name)
$UnbindW Function
%RESULT is set to indicate the number of unbound semaphores.
N - The number of unbound semaphores All other errors cause request cancellation
$UnbindW return codes
A resource remains bound until it is either explicitly unbound with the $Unbind or $UnbindW function or the binding user logs off or is restarted.
The following program unbinds the resource called &OSQ.SMITHERS&CSQ..
B %RC = $Unbind( 'SMITHERS' ) END
The semaphore name specified as the argument to $UnbindW can be an explicit name or it can contain the following wildcard characters:
| * | Matches any number of characters including none |
|---|---|
| ? | Matches any single character |
| " | Indicates that the next character must be treated literally, even if it is a wildcard character. |
For example:
| d.This string ... | d.Matches ... |
|---|---|
| C*D | CUSTID or COD or CLOD |
| S??T | SALT or SLOT or SORT |
| E"*CONCRETE | E*CONCRETE |
The following program unbinds the all resource that begin with the letters &OSQ.SMITH&CSQ..
B %RC = $UnbindW( 'SMITH*' ) END
$UnbindW is only available in Version 6.1 and later of the Sirius Mods.
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $Unbind and $UnbindW