ExtractorObject object

The ExtractorObject object provides the ability to extract the
compressed archive or data stream. If the archive or data stream is
compressed by a third-party tool, then only the following third-party
tools have been fully tested to work with ExtractorObject in the Windows
system: 7Z, Bandizip, WinRAR, and WinZIP.

Note

This object cannot be referenced in the .NET Assembly component,
otherwise the component will fail to be deployed.

Properties

ExtractorObject property	Datatype	Description
ClassDefinition	PowerObject	An object of type PowerObject containing information about the class definition of the object or control.
Password	String	Specifies the password when the archive is encrypted.

Events

ExtractorObject event	Occurs
Constructor	Immediately before the Open event occurs in the window.
Destructor	Immediately after the Close event occurs in the window.
Error	Occurs when an error is found in the file extraction operation.
Finished	Occurs when the file extraction is completed.
ProcessingFile	Occurs during the file extraction process. This event can be used to display the full path name of the file that is being decompressed.
SizeCompleted	Occurs during the file extraction process. This event can be used to display the total number of bytes in the file that has been decompressed.
Start	Occurs before the file extraction starts. This event can be used to display the total number of bytes in the file that will be decompressed.

Functions

ExtractorObject function	Datatype returned	Description
Cancel	Integer	Cancels the file extraction operation. Only used for the asynchronous interface.
ClassName	String	Returns the name assigned to the object.
Extract	Integer	Extracts the compressed archive or data stream.
GetContextService	Integer	Creates a reference to a context-specific instance of the specified service.
GetFilesCount	Long	Gets the number of files contained in the archive.
GetFilesList	Integer	Gets the list of files in the compressed package.
GetParent	PowerObject	Returns a reference to the name of the parent object.
PostEvent	Boolean	Adds an event to the end of the message queue for the control.
TriggerEvent	Integer	Triggers a specified event in the control and executes the script for the event.
TypeOf	Object	Returns the type of the object.

Document get from Powerbuilder help

Thank you for watching.

Powerbuilder Documentation 2022

August 21, 2023

Was this article helpful?

Connection Information

ExtractorObject object – PB Docs 2022