→ index of namespace default

→ index of project tkzip

→ index of module tkzip

Class `tkzip.Zip`

Synopsis:

Base classes:

core.Object

Methods:

addDir(String pathName) : boolean - add directory to archive
addFile(String pathName, Object data) : boolean - add file to archive
close() -
createLocal(String pathName) : boolean -
getCompressedSizeByIndex(int index) : UnsignedLong -
getIndexByName(String pathName) : int -
getNameByIndex(int index) : String -
getNumEntries() : int -
getSizeByIndex(int index) : UnsignedLong -
loadBufferByIndex(int index) : Buffer -
loadBufferByName(String pathName) : Buffer -
loadStringByIndex(int index) : String -
loadStringByName(String pathName) : String -
openLocal(String pathName) : boolean -
openLocalReadOnly(String pathName) : boolean -

Method addDir

add directory to archive

Signature

addDir	(	String	pathName	)
	:	boolean

Arguments

String

pathName

–

Returns

boolean

–

Description

(note) adding a file in a subdir w/o creating the dir first results in garbage file content

→ top of page

Method addFile

add file to archive

Signature

addFile	(	String	pathName	,
		Object	data
		)
	:	boolean

Arguments

String	pathName	–
Object	data	–	a String, an Array, a Buffer, or a Stream (or any other Object that implements the array/stream interface(s))

Returns

boolean

–

→ top of page

Method close

Signature

(

)

→ top of page

Method createLocal

Signature

createLocal	(	String	pathName	)
	:	boolean

Arguments

String

pathName

–

Returns

boolean

–

→ top of page

Method getCompressedSizeByIndex

Signature

getCompressedSizeByIndex	(	int	index	)
	:	UnsignedLong

Arguments

int

index

–

Returns

UnsignedLong

–

→ top of page

Method getIndexByName

Signature

getIndexByName	(	String	pathName	)
	:	int

Arguments

String

pathName

–

Returns

int

–

→ top of page

Method getNameByIndex

Signature

getNameByIndex	(	int	index	)
	:	String

Arguments

int

index

–

Returns

String

–

→ top of page

Method getNumEntries

Signature

getNumEntries

(

)

int

Returns

int

–

→ top of page

Method getSizeByIndex

Signature

getSizeByIndex	(	int	index	)
	:	UnsignedLong

Arguments

int

index

–

Returns

UnsignedLong

–

→ top of page

Method loadBufferByIndex

Signature

loadBufferByIndex	(	int	index	)
	:	Buffer

Arguments

int

index

–

Returns

Buffer

–

→ top of page

Method loadBufferByName

Signature

loadBufferByName	(	String	pathName	)
	:	Buffer

Arguments

String

pathName

–

Returns

Buffer

–

→ top of page

Method loadStringByIndex

Signature

loadStringByIndex	(	int	index	)
	:	String

Arguments

int

index

–

Returns

String

–

→ top of page

Method loadStringByName

Signature

loadStringByName	(	String	pathName	)
	:	String

Arguments

String

pathName

–

Returns

String

–

→ top of page

Method openLocal

Signature

openLocal	(	String	pathName	)
	:	boolean

Arguments

String

pathName

–

Returns

boolean

–

→ top of page

Method openLocalReadOnly

Signature

openLocalReadOnly	(	String	pathName	)
	:	boolean

Arguments

String

pathName

–

Returns

boolean

–

→ top of page

Project Modules:	`tkzip`
Project Classes:	`Zip`
Project Functions:
All Namespaces:	`default` , `graph` , `ui`
All Projects:	`core` , `eqxmms` , `ShaderVG` , `ShaderVG_Text` , `tkanalogrytm` , `tkchipmunk` , `tkclap` , `tkfileutils` , `tkfreeglut` , `tkfreetype2` , `tkfreeverb` , `tkmath` , `tkmidi` , `tkmidipipe` , `tkminnie` , `tkoldmath` , `tkopengl` , `tkportaudio` , `tkradiastools` , `tksamplechain` , `tksampleedit` , `tksampler` , `tksdl` , `tksdl_net` , `tksidplay2` , `tkspeexdsp` , `tksqlite` , `tktriangulate` , `tkui` , `tkvst2` , `tkzip` , `ui` , `yingtest`

auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:42:00

Class tkzip.Zip

Class `tkzip.Zip`