OpenEdge.Core.Memptr
- Last Updated: January 15, 2026
- 6 minute read
- OpenEdge
- Version 12.8
- Documentation
|
Method Summary
| Options | Name | Purpose | |
|---|---|---|---|
| Clear () |
/** Clears/resets the current memptr. Clears the memory and resets it to
its former size. */
|
||
| INTEGER CompareTo (IMemptrHolder) |
/* Comparison method, used by SortedSet's default comparer
- If the returned value is less than 0 (zero), then the current object sorts before the object passed in.
- If the returned value equals 0 (zero) , then the current object occupies the same position in the sort order.
- If the returned value is greater than 0(zero), then the current object sorts after the object passed in.
- If either object's Value is the unknown value (?), then that sorts high/early/before
@param IMemptrHolder The object to compare to.
@return integer 0 = same object
+1 = sorts after
-1 = sorts before */
|
||
| LOGICAL Equals (Object) |
|
||
| INTEGER GetByte (int64) |
/** Returns a byte at the specified position
@param int64 The position at which to return the byte.
@return integer The byte value at the current position */
|
||
| OpenEdge.Core.Memptr GetBytes (int64) |
/** Returns a Memptr instance containing the specified number of bytes,
starting at the current Position.
@param int64 The number of bytes to return
@return Memptr The complete data */
|
||
| OpenEdge.Core.Memptr GetBytes (int64, int64) |
/** Returns a Memptr instance containing the specified number of bytes,
starting at the specified postition.
@param int64 The starting position
@param int64 The number of bytes to return
@return Memptr The complete bucket data */
|
||
| RAW GetHash () |
/** Returns a hash of the current contents of the memptr. This can be used
for comparing memptr values quickly.
@return raw The hashed value of the memptr. */
|
||
| RAW GetHash (HashAlgorithmEnum) |
/** Returns a hash of the current contents of the memptr. This can be used
for comparing memptr values quickly.
@param HashAlgorithmEnum The algorithm to use for the message
@return raw The hashed value of the memptr. */
|
||
| INT64 GetPointerValue () |
/** Returns the pointer value of the current memptr.
@param int64 The pointer to memory represented by this memptr */
|
||
| LONGCHAR GetString (int64) |
/** Returns a string/character representation from a given start position,
for the remainder of the data.
@param int64 The start potision
@return longchar The character/string data requested */
|
||
| LONGCHAR GetString (int64, int64) |
/** Returns a string/character representation a particular number of bytes,
from a given start position.
@param int64 The start potision
@param int64 The size of the data (in bytes) to return
@return longchar The character/string data requested */
|
||
| LONGCHAR GetString (int64, int64, character) |
/** Returns a string/character representation a particular number of bytes,
from a given start position.
@param int64 The start potision
@param int64 The size of the data (in bytes) to return
@param character The target codepage for the character data
@return longchar The character/string data requested */
|
||
| LONGCHAR GetString (int64, int64, character, character) |
/** Returns a string/character representation a particular number of bytes,
from a given start position.
@param int64 The start potision
@param int64 The size of the data (in bytes) to return
@param character The source codepage for the character data
@param character The target codepage for the character data
@return longchar The character/string data requested */
|
||
| INTEGER HashCode () |
/* Hashing method for creating a proper index for use with Progress.Collections.HashMap
@return integer Result of the hash-code method using this object's comparable value(s) */
|
||
| PutBytes (int64, int64) |
/** Copies all of the bytes from a memptr into this memptr. The
caller is responsible for cleaning up the memptr.
@param int64 The pointer to memory represented by a memptr (via get-pointer-value).
@param int64 The size of the memptr represented by the pointer value. */
|
||
| PutBytes (memptr) |
/** Copies all of the bytes from a memptr (primitive) into this bucket. The
caller is responsible for cleaning up the memptr.
@param memptr The memptr containing the data. */
|
||
| PutBytes (raw) |
/** Copies all of the bytes from a raw into this memptr.
@param raw The raw variable containing the source data */
|
||
| CHARACTER ToString () |
|
||
| _Debug () |
/** Debug/dump of the contents of this object on a per-byte basic. COPY-LOB
can also be used for debug purposes (COPY-LOB objMemptr:Value TO FILE). */
|
Constructor Summary
| Options | Name | Purpose | |
|---|---|---|---|
| Memptr () |
|
||
| Memptr (int64) |
/** Constructor.
@param int64 The size of the memptr to be created. */
|
||
| Memptr (int64, int64) |
/** Constructor.
@param int64 The pointer to memory represented by a memptr (via get-pointer-value).
@param int64 The size of the memptr represented by the pointer value. */
|
||
| Memptr (memptr) |
/** Deep copy/clone of the input memptr. Caller is responsible for cleanup. */
|
||
| Memptr (raw) |
/** Deep copy/clone of the input memptr. */
|
Property Summary
| Options | Name | Purpose | |
|---|---|---|---|
| LOGICAL AutoDestroy |
|
||
| OpenEdge.Core.Memptr Empty |
|
||
| LOGICAL ExternalAllocation |
|
||
| INT64 PointerValue |
|
||
| INT64 Size |
|
||
| OpenEdge.Core.Memptr Value |
|
Method Detail
Clear ()
|
||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
INTEGER CompareTo (IMemptrHolder)
|
||||||||||||||||||||||||||||||
LOGICAL Equals (Object)
|
||||||||||||||||||||||||||||||
INTEGER GetByte (int64)
|
||||||||||||||||||||||||||||||
OpenEdge.Core.Memptr GetBytes (int64)
|
||||||||||||||||||||||||||||||
OpenEdge.Core.Memptr GetBytes (int64, int64)
|
||||||||||||||||||||||||||||||
RAW GetHash ()
|
||||||||||||||||||||||||||||||
RAW GetHash (HashAlgorithmEnum)
|
||||||||||||||||||||||||||||||
INT64 GetPointerValue ()
|
||||||||||||||||||||||||||||||
LONGCHAR GetString (int64)
|
||||||||||||||||||||||||||||||
LONGCHAR GetString (int64, int64)
|
||||||||||||||||||||||||||||||
LONGCHAR GetString (int64, int64, character)
|
||||||||||||||||||||||||||||||
LONGCHAR GetString (int64, int64, character, character)
|
||||||||||||||||||||||||||||||
INTEGER HashCode ()
|
||||||||||||||||||||||||||||||
PutBytes (int64, int64)
|
||||||||||||||||||||||||||||||
PutBytes (memptr)
|
||||||||||||||||||||||||||||||
PutBytes (raw)
|
||||||||||||||||||||||||||||||
CHARACTER ToString ()
|
||||||||||||||||||||||||||||||
_Debug ()
|
||||||||||||||||||||||||||||||
Constructor Detail
Memptr () |
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Memptr (int64)
|
||||||||||||||||
Memptr (int64, int64)
|
||||||||||||||||
Memptr (memptr)
|
||||||||||||||||
Memptr (raw)
|
||||||||||||||||
Property Detail
LOGICAL AutoDestroy
|
||||||||
|---|---|---|---|---|---|---|---|---|
OpenEdge.Core.Memptr Empty
|
||||||||
LOGICAL ExternalAllocation
|
||||||||
INT64 PointerValue
|
||||||||
INT64 Size
|
||||||||
OpenEdge.Core.Memptr Value
|
||||||||