SAP CL_SHM_AREA OO Class - Shared Memory: General Area Handle
CL_SHM_AREA is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_SHM_AREA including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_SHM_AREA is CL_ABAP_MEMORY_AREAMethod list of CL_SHM_AREA SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| CLASS_CONSTRUCTOR | CLASS_CONSTRUCTOR | Public |
| CALL METHOD cl_shm_area=>CLASS_CONSTRUCTOR...more details | ||
| DETACH | Remove Shared Lock | Public |
| CALL METHOD cl_shm_area=>DETACH...more details | ||
| DETACH_ALL_AREAS | Release all Locks for all Areas | Public |
| CALL METHOD cl_shm_area=>DETACH_ALL_AREAS...more details | ||
| DETACH_COMMIT | Release Change Lock and Flag for COMMIT | Public |
| CALL METHOD cl_shm_area=>DETACH_COMMIT...more details | ||
| DETACH_ROLLBACK | Release Change Lock and Discard Version | Public |
| CALL METHOD cl_shm_area=>DETACH_ROLLBACK...more details | ||
| GET_LOCK_KIND | Returns the Lock Type for an Area | Public |
| CALL METHOD cl_shm_area=>GET_LOCK_KIND...more details | ||
|
| ||
| GET_ROOT | Returns a Reference to the Root Object | Public |
| CALL METHOD cl_shm_area=>GET_ROOT...more details | ||
| MULTI_ATTACH | Multiple Attach (Requires this Method) | Public |
| CALL METHOD cl_shm_area=>MULTI_ATTACH...more details | ||
| _ATTACH_READ | Private | |
| CALL METHOD cl_shm_area=>_ATTACH_READ...more details | ||
| _ATTACH_READ71 | Private | |
| CALL METHOD cl_shm_area=>_ATTACH_READ71...more details | ||
| _ATTACH_UPDATE70 | Private | |
| CALL METHOD cl_shm_area=>_ATTACH_UPDATE70...more details | ||
| _ATTACH_WRITE70 | Private | |
| CALL METHOD cl_shm_area=>_ATTACH_WRITE70...more details | ||
| _DETACH | Private | |
| CALL METHOD cl_shm_area=>_DETACH...more details | ||
| _DETACH_ALL_AREAS | Private | |
| CALL METHOD cl_shm_area=>_DETACH_ALL_AREAS...more details | ||
| _DETACH_AREA | Private | |
| CALL METHOD cl_shm_area=>_DETACH_AREA...more details | ||
| _DETACH_AREA71 | Private | |
| CALL METHOD cl_shm_area=>_DETACH_AREA71...more details | ||
| _DETACH_COMMIT | Private | |
| CALL METHOD cl_shm_area=>_DETACH_COMMIT...more details | ||
| _DETACH_ROLLBACK | Private | |
| CALL METHOD cl_shm_area=>_DETACH_ROLLBACK...more details | ||
| _FINISH_MULTI_ATTACH | Private | |
| CALL METHOD cl_shm_area=>_FINISH_MULTI_ATTACH...more details | ||
| _FREE_AREA | Private | |
| CALL METHOD cl_shm_area=>_FREE_AREA...more details | ||
| _FREE_AREA71 | Private | |
| CALL METHOD cl_shm_area=>_FREE_AREA71...more details | ||
| _FREE_INSTANCE | Private | |
| CALL METHOD cl_shm_area=>_FREE_INSTANCE...more details | ||
| _FREE_INSTANCE71 | Private | |
| CALL METHOD cl_shm_area=>_FREE_INSTANCE71...more details | ||
| _GET_INSTANCE_INFOS | Private | |
| CALL METHOD cl_shm_area=>_GET_INSTANCE_INFOS...more details | ||
| _GET_INSTANCE_INFOS71 | Private | |
| CALL METHOD cl_shm_area=>_GET_INSTANCE_INFOS71...more details | ||
| _GET_INSTANCE_INFOS804 | Private | |
| CALL METHOD cl_shm_area=>_GET_INSTANCE_INFOS804...more details | ||
| _HAS_ACTIVE_PROPERTIES | Private | |
| CALL METHOD cl_shm_area=>_HAS_ACTIVE_PROPERTIES...more details | ||
| _INVALIDATE_AREA | Private | |
| CALL METHOD cl_shm_area=>_INVALIDATE_AREA...more details | ||
| _INVALIDATE_AREA71 | Private | |
| CALL METHOD cl_shm_area=>_INVALIDATE_AREA71...more details | ||
| _INVALIDATE_INSTANCE | Private | |
| CALL METHOD cl_shm_area=>_INVALIDATE_INSTANCE...more details | ||
| _INVALIDATE_INSTANCE71 | Private | |
| CALL METHOD cl_shm_area=>_INVALIDATE_INSTANCE71...more details | ||
| _PREPARE_MULTI_ATTACH_READ | Private | |
| CALL METHOD cl_shm_area=>_PREPARE_MULTI_ATTACH_READ...more details | ||
| _PREPARE_MULTI_ATTACH_READ71 | Private | |
| CALL METHOD cl_shm_area=>_PREPARE_MULTI_ATTACH_READ71...more details | ||
| _PREPARE_MULTI_ATTACH_UPDATE70 | Private | |
| CALL METHOD cl_shm_area=>_PREPARE_MULTI_ATTACH_UPDATE70...more details | ||
| _PREPARE_MULTI_ATTACH_WRITE70 | Private | |
| CALL METHOD cl_shm_area=>_PREPARE_MULTI_ATTACH_WRITE70...more details | ||
| _PROPAGATE_AREA | Private | |
| CALL METHOD cl_shm_area=>_PROPAGATE_AREA...more details | ||
| _PROPAGATE_INSTANCE | Private | |
| CALL METHOD cl_shm_area=>_PROPAGATE_INSTANCE...more details | ||
| _SET_ROOT | Private | |
| CALL METHOD cl_shm_area=>_SET_ROOT...more details | ||
CL_SHM_AREA attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| AFFECT_ALL_SERVERS | Constant | Invalidate/Delete Area on All Servers | 281119721 | LIKE SHM_AFFECT_SERVER | Public |
| AFFECT_ALL_SERVERS_BUT_LOCAL | Constant | Invalidate/Delete Area on All Servers Except Current | 281119722 | LIKE SHM_AFFECT_SERVER | Public |
| AFFECT_LOCAL_SERVER | Constant | Invalidate/Delete Area Only on Current Server | 281119720 | LIKE SHM_AFFECT_SERVER | Public |
| ALL_CLIENTS | Constant | All Clients | '*' | LIKE SHM_CLIENT | Public |
| ATTACH_MODE_DEFAULT | Constant | Lock must be available immediately | 1302197000 | LIKE SHM_ATTACH_MODE | Public |
| ATTACH_MODE_DETACH_READER | Constant | Read locks can be released | 1302197001 | LIKE SHM_ATTACH_MODE | Public |
| ATTACH_MODE_WAIT | Constant | Lock must be available within a period of time | 1302197002 | LIKE SHM_ATTACH_MODE | Public |
| ATTACH_MODE_WAIT_2ND_TRY | Constant | (Internal) Repeat Lock Request | 1302197003 | LIKE SHM_ATTACH_MODE | Protected |
| AUTO_BUILD_CURRENT_USER | Constant | Using the current user | 'X' | LIKE SHM_AUTO_BUILD | Public |
| AUTO_BUILD_NONE | Constant | None | ' ' | LIKE SHM_AUTO_BUILD | Public |
| AUTO_BUILD_SYSTEM_USER | Constant | Using the system user | 'S' | LIKE SHM_AUTO_BUILD | Public |
| BUILD_KIND_DUE_TO_INVALIDATION | Constant | Autostart for Read Request and Every Invalidation | 1107197102 | LIKE SHM_BUILD_KIND | Public |
| BUILD_KIND_DUE_TO_READ_REQUEST | Constant | Autostart for Read Request | 1107197101 | LIKE SHM_BUILD_KIND | Public |
| BUILD_KIND_NONE | Constant | No Autostart | 1107197100 | LIKE SHM_BUILD_KIND | Public |
| BUILD_KIND_STARTUP | Constant | Autostart for Server Start and Every Invalidation | 1107197103 | LIKE SHM_BUILD_KIND | Public |
| BUILD_KIND_STARTUP_OR_READ | Constant | Autostart if read request and server start | 1107197104 | LIKE SHM_BUILD_KIND | Public |
| BUILD_KIND_STARTUP_READ_OR_INV | Constant | Autostart if read request, invalidated, and server start | 1107197105 | LIKE SHM_BUILD_KIND | Public |
| CLIENT | Instance Attribute | Client | LIKE MANDT | Public | |
| DEFAULT_INSTANCE | Constant | Default Name for the Area Instance | '$DEFAULT_INSTANCE$' | LIKE SHM_INST_NAME | Public |
| DISPLACE_KIND_DISPLACABLE | Constant | Displacement Possible | 1208200202 | LIKE SHM_DISPLACE_KIND | Public |
| DISPLACE_KIND_NONE | Constant | Displacement Not Possible | 1208200200 | LIKE SHM_DISPLACE_KIND | Public |
| DISPLACE_KIND_SERIALIZABLE | Constant | Displacement Possible with Backup and Recovery | 1208200201 | LIKE SHM_DISPLACE_KIND | Public |
| INST_NAME | Instance Attribute | Name of a Shared Object Instance of an Area | LIKE SHM_INST_NAME | Public | |
| INST_TRACE_ACTIVE | Instance Attribute | (Internal) Flag: Trace Active? | ABAP_FALSE | LIKE ABAP_BOOL | Protected |
| INST_TRACE_SERVICE | Instance Attribute | (Internal) Reference to Trace Class | LIKE IF_SHM_TRACE | Protected | |
| INVOCATION_MODE_AUTO_BUILD | Constant | Automatic Call of the Constructor | 0319200301 | LIKE SHM_CONSTR_INVOCATION_MODE | Public |
| INVOCATION_MODE_EXPLICIT | Constant | Explicit Call of the Constructor | 0319200300 | LIKE SHM_CONSTR_INVOCATION_MODE | Public |
| LIFETIME_IDLE | Constant | Maximum Unused Time | 1125600003 | LIKE SHM_LIFETIME_KIND | Public |
| LIFETIME_INVALIDATION | Constant | Expiry Time | 1125600001 | LIKE SHM_LIFETIME_KIND | Public |
| LIFETIME_NONE | Constant | No Entry | 1125600000 | LIKE SHM_LIFETIME_KIND | Public |
| LIFETIME_REFRESH | Constant | Refresh Time | 1125600002 | LIKE SHM_LIFETIME_KIND | Public |
| LIFE_CONTEXT_APPSERVER | Constant | Application Server | 0109200001 | LIKE SHM_LIFE_CONTEXT | Public |
| LIFE_CONTEXT_MEMORY | Constant | ABAP Memory | 0109200004 | LIKE SHM_LIFE_CONTEXT | Public |
| LIFE_CONTEXT_MODE | Constant | External mode | 0109200003 | LIKE SHM_LIFE_CONTEXT | Public |
| LIFE_CONTEXT_SESSION | Constant | Session | 0109200002 | LIKE SHM_LIFE_CONTEXT | Public |
| LOCK_KIND_COMPLETION_ERROR | Constant | Change Handle with Error When Using Commit | 0109199705 | LIKE SHM_LOCK_KIND | Public |
| LOCK_KIND_DETACHED | Constant | Handle Released | 0109199701 | LIKE SHM_LOCK_KIND | Public |
| LOCK_KIND_OUT_OF_MEMORY | Constant | Memory error in area build | 0109199706 | LIKE SHM_LOCK_KIND | Public |
| LOCK_KIND_READ | Constant | Read Handle | 0109199702 | LIKE SHM_LOCK_KIND | Public |
| LOCK_KIND_UPDATE | Constant | Update Handle | 0109199704 | LIKE SHM_LOCK_KIND | Public |
| LOCK_KIND_WRITE | Constant | Write Handle | 0109199703 | LIKE SHM_LOCK_KIND | Public |
| PROPERTIES | Instance Attribute | Area Attributes | LIKE SHM_PROPERTIES | Public | |
| PROP_KIND_AUTOMATIC | Constant | Automatic Using Dependencies | 0159200002 | LIKE SHM_PROPAGATION_KIND | Public |
| PROP_KIND_NONE | Constant | No Synchronization | 0159200000 | LIKE SHM_PROPAGATION_KIND | Public |
| PROP_KIND_USER_TRIGGERED | Constant | Explicit Call | 0159200001 | LIKE SHM_PROPAGATION_KIND | Public |
| RC_DONE | Constant | Return Value: Execution Without Error | 0304192400 | LIKE SHM_RC | Public |
| RC_INSTANCE_NAME_NOT_FOUND | Constant | Return Value: Specified Instance Does Not Exist | 0304192402 | LIKE SHM_RC | Public |
| RC_NOTHING_TO_BE_DONE | Constant | Return Value: Operation Fulfilled Without Execution | 0304192401 | LIKE SHM_RC | Public |
| RC_PRELOAD_ALREADY_IN_BUFFER | Instance Attribute | LIKE | Private | ||
| RC_PRELOAD_DONE | Instance Attribute | LIKE | Private | ||
| RC_PRELOAD_ERROR | Instance Attribute | LIKE | Private | ||
| RC_PRELOAD_FULL_BUFFER | Instance Attribute | LIKE | Private | ||
| STAT_TRACE_ACTIVE | Static Attribute | (Internal) Flag: Trace Active? | ABAP_FALSE | LIKE ABAP_BOOL | Private |
| STAT_TRACE_SERVICE | Static Attribute | (Internal) Reference to Trace Class | LIKE IF_SHM_TRACE | Private | |
| _LOCK | Instance Attribute | (Internal) ModeLockRefId | LIKE %_C_POINTER | Protected | |
| _MIN_VERSION_ | Constant | (Internal) Minimum supported area version | 21 | LIKE I | Public |
Events of Class CL_SHM_AREA
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... SHM_COMMIT_EVENT - Triggered During DETACH_COMMITSHM_ROLLBACK_EVENT - Triggered During DETACH_ROLLBACK
Links to Related Class(s)
CL_SHM_A...Full list of available SAP object classes
Search for further information about these or an SAP related objects