API

Note that nothing in this package is exported.

Index

• CHM.CHMFile
• CHM.CHMUnitInfo
• CHM.close
• CHM.open
• CHM.readdir
• CHM.resolve
• CHM.retrieve
• CHM.unitinfo

Types

# CHM.CHMFile — Type.

type CHMFile

Custom type for dispatching only. Not needed by user.

# CHM.CHMUnitInfo — Type.

type CHMUnitInfo

Julia type wrapper for a C struct from CHMLib that contains information on metadata for an object within the .chm file.

Functions

# CHM.close — Function.

close(ptr::Ptr{CHMFile})

Close a file with CHMLib.

# CHM.open — Function.

open(path::ASCIIString)

Open a file with CHMLib.

# CHM.readdir — Function.

readdir(ptr::Ptr{CHMFile}, path::ASCIIString)

Read the contents of a given directory in the CHM file. Use UNIX path conventions. Root level is "/". Returns the file and directory names.

# CHM.resolve — Function.

resolve(ptr::Ptr{CHMFile}, path::ASCIIString)

Returns true if path in the .chm file resolves to a file, else false.

# CHM.retrieve — Function.

retrieve(ptr::Ptr{CHMFile}, path::ASCIIString)

Returns a string containing the contents of a text file at path within the .chm file.

# CHM.unitinfo — Function.

unitinfo(ptr::Ptr{CHMFile}, path::ASCIIString)

Returns a CHMUnitInfo object for the file at path within the .chm file.