Log.PopLogFolder Method

Description

The PopLogFolder method pops the top folder of the folder stack out of that stack. Once this is done, the folder that follows the popped out folder becomes the top folder of the stack. The top folder is the default one. This means that by default, the Log.CreateFolder method will create new folders in it and all the messages posted by the Log.Error, Log.Warning, Log.Message, Log.Event, Log.Picture, Log.File and Log.Link methods will be placed in that folder. To push the needed folder to the top of the folder stack, call the PushLogFolder method.

Declaration

Applies To

The method is applied to the following object:

Result Value

None.

Example

The following example creates a structure of folders and messages in the test log. This structure is shown in the image below.

FolderID = []
Log.Message("Message1")
Log.Error("Error1")
for i in range(0, 3):
  FolderID.append(Log.CreateFolder("Folder" + str(i)))
  Log.PushLogFolder(FolderID[i])
  Log.Warning("Warning" + str(i))
Log.Event("Event1")
Log.PopLogFolder()
Log.CreateFolder("Folder4")
Log.Link("www.oursite.com")
Log.PopLogFolder()
Log.Message("Message2")
Log.CreateFolder("Folder5", "", pmHigher, Log.CreateNewAttributes(), FolderID[2])

If you need to activate a log folder right after creating it, you can use the AppendFolder method instead of the combination of CreateFolder and PushLogFolder. The following code snippet shows how this can be done in the example above:

FolderID.append(Log.CreateFolder("Folder" + str(i)))
Log.PushLogFolder(FolderID[i])
# is equal to
FolderID.append(Log.AppendFolder("Folder" + str(i)))

See Also

About Test Log
Using Folders
Log.CreateFolder Method
Log.AppendFolder Method
Log.PushLogFolder Method
Log.Error Method
Log.Warning Method
Log.Message Method
Log.Event Method
Log.Picture Method
Log.File Method
Log.Link Method