$Bind: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
Line 18: Line 18:
</p>
</p>
<p>%result is set to indicate the success of the function.</p>
<p>%result is set to indicate the success of the function.</p>
===$Bind return codes===
<p class="code">  
<p class="code">  
  >=0 - User number that currently has resource bound
  >=0 - User number that currently has resource bound
Line 24: Line 26:
  -10 - Resource already bound by current user
  -10 - Resource already bound by current user
  -20 - Resource successfully bound
  -20 - Resource successfully bound
</p>
<p class="caption">$Bind return codes
</p>
</p>


It is the responsibility of each programming team to establish resource naming conventions appropriate to its site. A resource remains bound until it is either explicitly unbound with the [[$Unbind and $UnbindW|$Unbind or $UnbindW]] function or the binding user logs off or is restarted.  
==Usage notes==
<ul>
<li>It is the responsibility of each programming team to establish resource naming conventions appropriate to its site. A resource remains bound until it is either explicitly unbound with the [[$Unbind and $UnbindW|$Unbind or $UnbindW]] function or the binding user logs off or is restarted.  
</ul>


The following program binds the resource called 'SMITHERS'.
==Examples==
The following program binds the resource called 'SMITHERS':


<p class="code">begin
<p class="code">begin
  %rc = $Bind('SMITHERS')
  %rc = $Bind('SMITHERS')
end
end
</p>
</p>
Line 39: Line 43:
The following program binds the resource called 'BURNS', waiting up to 10 seconds (10,000 milliseconds) for the resource to become available.
The following program binds the resource called 'BURNS', waiting up to 10 seconds (10,000 milliseconds) for the resource to become available.
<p class="code">begin
<p class="code">begin
  %rc = $Bind('BURNS', 10000)
  %rc = $Bind('BURNS', 10000)
end
end
</p>
</p>

Revision as of 00:53, 26 October 2012

Fast, easy synchronization of system wide resource

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The is no OO equivalent for the $Bind function.

The $Bind function provides a fast and convenient way of synchronizing access to system wide resources.

$Bind accepts two arguments and returns a numeric code.

The first argument is the name of the resource to be bound. This resource name can be any string up to 255 bytes long. Only one user can have a resource bound at a time.

The second argument is the number of milliseconds to wait for the resource if it is not immediately available. This argument is only available in Sirius Mods Version 6.9 and later. If it is not specified, $Bind returns immediately, indicating that the resource was not available.

Syntax

<section begin="syntax" />%result = $Bind(res_name, wait_time) <section end="syntax" />

%result is set to indicate the success of the function.

$Bind return codes

>=0 - User number that currently has resource bound -1 - Resource name missing -2 - Insufficient storage to do the bind -10 - Resource already bound by current user -20 - Resource successfully bound

Usage notes

  • It is the responsibility of each programming team to establish resource naming conventions appropriate to its site. 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.

Examples

The following program binds the resource called 'SMITHERS':

begin %rc = $Bind('SMITHERS') end

The following program binds the resource called 'BURNS', waiting up to 10 seconds (10,000 milliseconds) for the resource to become available.

begin %rc = $Bind('BURNS', 10000) end

Products authorizing $Bind

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Bind&oldid=28371"