Stack Class

Entisoft Tools 2.0 Object Library
Version 2.1 Build 208
<-- Previous || Index || Main || Topics || Next -->
Declarations Section

Count Property
Returns the number of items in the Stack.
Is Empty Property
Return True if the Stack is empty. Return False if the Stack contains one or more items.
Item Property
"Get Nth From Bottom" Return the value of the Nth item from the bottom of the stack, The item at the bottom of the stack is numbered 1 (one). "Set Nth From Bottom" Set the value of the Nth item from the bottom of the stack, "Set Nth From Bottom" Set the value of the Nth item from the bottom of the stack,
Name Property
Assign a Name to this Stack. Return the Name of this Stack when the Name is not an Object. Return the Name of this Stack when the Name is an Object.
Nth From Top Property
Return the value of the Nth item from the top of the stack, The item at the top of the stack is numbered 1 (one). Set the value of the Nth item from the top of the stack, Set the value of the Nth item from the top of the stack,
Tag Property
Assign a Tag to this Stack. The Tag can be any type of Data. Return the Tag of this Stack when the Tag is not an Object. Return the Tag of this Stack when the Tag is an Object.
Drop Function
Drop N items from the top of the stack. Function returns True upon success and False upon failure.
Duplicate Function
Duplicate the top N values on the stack. Function returns True upon success and False upon failure.
Over Function
Duplicate the value that is second from (next to) the top of the stack. Function returns True upon success and False upon failure.
Peek Function
Copy the value on the top of the stack into rValue, without removing that value from the stack. Function returns true upon success.
Pick Function
Pushes a copy of the Nth element from the top of the stack. Function returns True upon success and False upon failure.
Pop Function
Pop the value off the top of the stack and copy the value into rValue. Function returns True upon success and False upon failure.
Pop Multi Function
Pop one or more values off the top of the stack. Values are popped off the stack are assigned to the arguments from left-to-right. The top of the stack is assigned to the leftmost argument.
Push Sub
Push a new value onto the top of the stack.
Push Multi Sub
Push one or more values onto the top of the stack. Argument values are pushed onto the stack in order from left to right. The last argument ends up on the top of the stack.
Remove Function
Remove the value on the top of the stack (if vElement is 0), or remove the Nth element from the bottom of the stack (if vElement is >0). Return True upon success and False upon failure.
Remove All Sub
Remove all of the items from the Stack.
Reverse Function
Reverse the positions of the N items at the top of the stack. Function returns True upon success and False upon failure.
Roll Down Function
Roll the top N stack items down towards the stack bottom. Item previously at position Top - N + 1 ends up on the top of the stack. Function returns True upon success and False upon failure.
Roll Up Function
Roll the top N stack items up towards the stack top. Item previously on the top of the stack ends up at position Top - N + 1. Function returns True upon success and False upon failure.
Rotate Function
Rotate down the top THREE items on the stack. Item previously at position Top - 2 ends up on the top of the stack. Function returns True upon success and False upon failure.
String View Function
Return a copy of all of the stack items in the form of a string. Return value is prefixed by vPrefix and followed by vSuffix. Stack items are separated by vSeparator in the result string.
Swap Function
Swap the two values on the top of a stack. Function returns True upon success and False upon failure.

This Windows-based ActiveX DLL provides many useful routines through its function-bearing and data structure classes. Consult the Help file for more information, or call us at 1-310-472-3736. For the latest news and files, visit our home page on the World Wide Web: http://www.entisoft.com