Difference between revisions of "SharedMemory"

From Lianjapedia
Jump to: navigation, search
Line 21: Line 21:
 
!Args
 
!Args
 
!width="50%"|Description
 
!width="50%"|Description
 +
|-
 +
|valign="top"|Clear
 +
|valign="top"|None
 +
|valign="top"|Clears items
 +
|-
 
|-
 
|-
 
|valign="top"|Detach
 
|valign="top"|Detach
Line 28: Line 33:
 
|valign="top"|Attach
 
|valign="top"|Attach
 
|valign="top"|key as Character [, size as Numeric]
 
|valign="top"|key as Character [, size as Numeric]
|valign="top"|Attaches to the shared memory segment specified in key, creating it to the specified size if it does not exist
+
|valign="top"|Attaches to the shared memory segment specified in key of size size. The segment is created if it does not exist
 
|-
 
|-
 
|valign="top"|GetItem
 
|valign="top"|GetItem
 
|valign="top"|item as Character
 
|valign="top"|item as Character
 
|valign="top"|Gets the named item
 
|valign="top"|Gets the named item
 +
|-
 +
|valign="top"|Lock
 +
|valign="top"|None
 +
|valign="top"|Lock the segment.  This is handled automatically for individual items, but can be used (along with unlock()) for accessing multiple items.
 
|-
 
|-
 
|valign="top"|SetItem
 
|valign="top"|SetItem
 
|valign="top"|item as Character, value as Expression
 
|valign="top"|item as Character, value as Expression
 
|valign="top"|Sets the named item to the named value
 
|valign="top"|Sets the named item to the named value
 +
|-
 +
|-
 +
|valign="top"|Unlock
 +
|valign="top"|item as Character, value as Expression
 +
|valign="top"|Unlock the segment
 
|-
 
|-
 
|}
 
|}

Revision as of 12:27, 1 June 2015

Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.

Properties

This class supports the following properties:

Property Access (R/RW) Value Description

Methods

This class supports the following methods:

Method Args Description
Clear None Clears items
Detach None Detaches from the currently attached shared memory segment
Attach key as Character [, size as Numeric] Attaches to the shared memory segment specified in key of size size. The segment is created if it does not exist
GetItem item as Character Gets the named item
Lock None Lock the segment. This is handled automatically for individual items, but can be used (along with unlock()) for accessing multiple items.
SetItem item as Character, value as Expression Sets the named item to the named value
Unlock item as Character, value as Expression Unlock the segment

Events

This class supports the following events:

Event Args Description