| class CleanupStack |
A collection of static functions that are used to add resources to and remove resources from the cleanup stack.
| Public Member Functions | |
|---|---|
| IMPORT_C void | Check(TAny *) |
| IMPORT_C void | Pop() |
| IMPORT_C void | Pop(TInt) |
| void | Pop(TAny *) |
| void | Pop(TInt, TAny *) |
| IMPORT_C void | PopAndDestroy() |
| IMPORT_C void | PopAndDestroy(TInt) |
| void | PopAndDestroy(TAny *) |
| void | PopAndDestroy(TInt, TAny *) |
| IMPORT_C void | PushL(TAny *) |
| IMPORT_C void | PushL(CBase *) |
| IMPORT_C void | PushL(TCleanupItem) |
| void | Pop | ( | TAny * | aExpectedItem | ) | [static, inline] |
Pops an object from the top of the cleanup stack.
The function has two modes of operation, depending on whether it is part of a debug build or a release build.
1. In a debug build, the function checks that the specified item is at the top of the cleanup stack before attempting to pop it; an E32USER-CBase 90 panic is raised if the check fails.
2 In a release build, the function just pops the object which is at the top of the cleanup stack; no checking is done.
| TAny * aExpectedItem | A pointer to the item expected to be at the top of the cleanup stack. In a release build, this parameter is not used. |
| void | Pop | ( | TInt | aCount, |
| TAny * | aLastExpectedItem | |||
| ) | [static, inline] | |||
Pops the specified number of objects from the top of the cleanup stack.
The function has two modes of operation, depending on whether it is part of a debug build or a release build.
1. In a debug build, the function pops (aCount-1) items from the cleanup stack, and then checks that the specified item is the next one on the cleanup stack before attempting to pop it; an E32USER-CBase 90 panic is raised if the check fails.
2. In a release build, the function just pops aCount items from the cleanup stack; no checking is done.
| void | PopAndDestroy | ( | TAny * | aExpectedItem | ) | [static, inline] |
Pops an object from the top of the cleanup stack, and cleans it up.
The function has two modes of operation, depending on whether it is part of a debug build or a release build.
1. In a debug build, the function checks that the specified item is at the top of the cleanup stack before attempting to pop and clean it up; an E32USER-CBase 90 panic is raised if the check fails.
2. In a release build, the function just pops and cleans up the object at the top of the cleanup stack; no checking is done.
| TAny * aExpectedItem | A pointer to the item expected to be at the top of the cleanup stack. In a release build, this parameter is not used. |
| void | PopAndDestroy | ( | TInt | aCount, |
| TAny * | aLastExpectedItem | |||
| ) | [static, inline] | |||
Pops the specified number of objects from the top of the cleanup stack, and cleans them up.
The function has two modes of operation, depending on whether it is part of a debug build or a release build.
1. In a debug build, the function pops and cleans up (aCount-1) items from the cleanup stack, and then checks that the specified item is the next one on the cleanup stack before attempting to pop it and clean it up; an E32USER-CBase 90 panic is raised if the check fails.
2. In a release build, the function just pops and cleans up aCount items from the cleanup stack; no checking is done.