$Bind List: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Automatically generated page update) |
||
(38 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
<span class="pageSubtitle">Return list of bound semaphores onto a $list</span> | <span class="pageSubtitle">Return list of bound semaphores onto a $list</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Bind_List function.</p> | ||
This function retrieves semaphores bound with $Bind by a specific or all users. | This function retrieves semaphores bound with <var>[[$Bind]]</var> by a specific or all users. | ||
The $Bind_List function accepts three arguments and returns a number indicating the success of the function. | The <var>$Bind_List</var> function accepts three arguments and returns a number indicating the success of the function. | ||
==Syntax== | |||
<p class="syntax"><span class="term">%rc</span> <span class="literal">= $Bind_List(</span><span class="term">olist</span>, <span class="squareb">[</span><span class="term">sem_name</span><span class="squareb">]</span>, <span class="squareb">[</span><span class="term">user_num</span><span class="squareb">]</span>) | |||
</p> | |||
The | ===Syntax terms=== | ||
<table> | |||
<tr><th>%rc</th> | |||
<td>The number of items added to <var class="term">olist</var>, or a negative (error) [[#Return codes|return code]].</td></tr> | |||
The | <tr><th>olist</th> | ||
== | <td>The output [[$lists|$list]] identifier. If the output $list is not empty, data is added to the end of the $list. See [[#Usage notes|"Usage notes"]] for the $list format.</td></tr> | ||
< | |||
< | <tr><th>sem_name</th> | ||
< | <td>The name of the semaphore for which information is to be returned. This value can be a single specific semaphore name, or it can be a wildcard string that matches a number of semaphores. The argument default value is asterisk (<tt>*</tt>), which means to return all semaphores bound by all users or by a specific user. </td></tr> | ||
</ | |||
< | <tr><th>user_num</th> | ||
<td>The user number of the user for which bound semaphores are to be returned. This optional argument defaults to -1, which means return semaphores bound by all users.</td></tr> | |||
</table> | |||
===Return codes=== | |||
<table> | |||
<tr><td>>=0</td> | |||
<td>Number of bound semaphores returned</td></tr> | |||
<tr><td>-3</td> | |||
<td>$list full or out of CCATEMP</td></tr> | |||
</table>All other errors result in request cancellation | |||
==Usage notes== | |||
< | <ul> | ||
<li>The format of the <var class="term">olist</var> output $list is shown below: | |||
<table> | |||
<tr><th>Offset</th><th>Contents</th> | |||
<tr><td>0-4</td> | |||
<td>The user number of the user that has the semaphore bound | |||
represented as a string with leading zeros included.</td></tr> | |||
</ | <tr><td>5-14</td> | ||
<td>The userid of the user that has the semaphore bound | |||
represented as a string padded with trailing blanks.</td></tr> | |||
<tr><td>15-end</td> | |||
<td>The name of the bound semaphore.</td></tr> | |||
</table> </li> | |||
The semaphore name specified in the second argument can be an explicit name or it can contain the following wildcard characters: | <li>The semaphore name specified in the second argument can be an explicit name or it can contain the following wildcard characters: | ||
<table | <table> | ||
<tr>< | <tr><td>*</td> | ||
<td>Matches any number of characters including none</td></tr> | <td>Matches any number of characters including none</td></tr> | ||
<tr>< | |||
<tr><td>?</td> | |||
<td>Matches any single character</td></tr> | <td>Matches any single character</td></tr> | ||
<tr>< | |||
<tr><td>"</td> | |||
<td>Indicates that the next character must be treated literally even if it is a wildcard character. | <td>Indicates that the next character must be treated literally even if it is a wildcard character. | ||
</td></tr> | </td></tr> | ||
</table> | </table> | ||
For example | For example: | ||
:<code>C*D</code> matches <code>CUSTID</code>, <code>COD</code> or <code>CLOD</code>. | |||
:<code>S??T</code> matches <code>SALT</code>, <code>SLOT</code> or <code>SORT</code>. | |||
:<code>E"*CONCRETE</code> matches <code>E*CONCRETE</code>. </li> | |||
</ul> | |||
The following code fragment retrieves all semaphores bound by the current user where the semaphore name ends with the letters | ==Example== | ||
The following code fragment retrieves all semaphores bound by the current user where the semaphore name ends with the letters <code>_TEMP</code> into a $list and sorts the $list by semaphore name. | |||
<p class="code"> % | <p class="code">%rc = $Bind_List(%olist, '*_TEMP', $USER) | ||
%slist = $ListSort(%olist, '16,255, A') | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Bind_List]] | [[Category:$Functions|$Bind_List]] |
Latest revision as of 22:51, 20 September 2018
Return list of bound semaphores onto a $list
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Bind_List function.
This function retrieves semaphores bound with $Bind by a specific or all users.
The $Bind_List function accepts three arguments and returns a number indicating the success of the function.
Syntax
%rc = $Bind_List(olist, [sem_name], [user_num])
Syntax terms
%rc | The number of items added to olist, or a negative (error) return code. |
---|---|
olist | The output $list identifier. If the output $list is not empty, data is added to the end of the $list. See "Usage notes" for the $list format. |
sem_name | The name of the semaphore for which information is to be returned. This value can be a single specific semaphore name, or it can be a wildcard string that matches a number of semaphores. The argument default value is asterisk (*), which means to return all semaphores bound by all users or by a specific user. |
user_num | The user number of the user for which bound semaphores are to be returned. This optional argument defaults to -1, which means return semaphores bound by all users. |
Return codes
>=0 | Number of bound semaphores returned |
-3 | $list full or out of CCATEMP |
All other errors result in request cancellation
Usage notes
- The format of the olist output $list is shown below:
Offset Contents 0-4 The user number of the user that has the semaphore bound represented as a string with leading zeros included. 5-14 The userid of the user that has the semaphore bound represented as a string padded with trailing blanks. 15-end The name of the bound semaphore. - The semaphore name specified in the second argument 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:
C*D
matchesCUSTID
,COD
orCLOD
.S??T
matchesSALT
,SLOT
orSORT
.E"*CONCRETE
matchesE*CONCRETE
.
Example
The following code fragment retrieves all semaphores bound by the current user where the semaphore name ends with the letters _TEMP
into a $list and sorts the $list by semaphore name.
%rc = $Bind_List(%olist, '*_TEMP', $USER) %slist = $ListSort(%olist, '16,255, A')