Cache ActiveX Reference Documentation

Cache

Current Version: 10.1.2

Requires Chilkat Bundle License

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Cache" instead of "Chilkat.Cache"
For a specific major version, use "Chilkat.Cache.<major_version>", such as "Chilkat.Cache.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Cache")

(AutoIt)
$obj = ObjCreate("Chilkat.Cache")

(Visual Basic 6.0)
Dim obj As New ChilkatCache

(VBScript)
set obj = CreateObject("Chilkat.Cache")

(Delphi)
obj := TChilkatCache.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.Cache')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Cache")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Cache', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.Cache");

Properties

DebugLogFilePath

DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.

LastBinaryResult

LastBinaryResult As Variant (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastEtagFetched

LastEtagFetched As String (read-only)

The ETag of the last item fetched from cache.

LastExpirationFetchedStr

LastExpirationFetchedStr As String (read-only)

Expiration date/time of the last item fetched from cache in RFC822 string format.

LastHitExpired

LastHitExpired As Long (read-only)

1 if the LastExpirationFetched is before the current date/time. Otherwise 0.

LastKeyFetched

LastKeyFetched As String (read-only)

The key of the last item fetched from cache. (For web pages, the key is typically the canonicalized URL. Otherwise, the key is a unique identifer used to access the cached item.)

LastMethodSuccess

LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

Level

Level As Long

The number of directory levels in the cache. Possible values are:

0: All cache files are in a single directory (the cache root).

1: Cache files are located in 256 sub-directories numbered 0 .. 255 directly under the cache root.

2: There are two levels of sub-directories under the cache root. The 1st level has 256 sub-directories numbered 0 .. 255 directly under the cache root. The 2nd level allows for up to 256 sub-directories (0..255) under each level-1 directory. Cache files are stored in the leaf directories.

NumRoots

NumRoots As Long (read-only)

The number of root directories composing the cache. A typical multi-root cache would place each root on a separate hard drive.

VerboseLogging

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version As String (read-only)

Version of the component/library, such as "10.1.0"

More Information and Examples

(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.

Methods

AddRoot

AddRoot(path As String)

Must be called once for each cache root. For example, if the cache is spread across D:\cacheRoot, E:\cacheRoot, and F:\cacheRoot, an application would setup the cache object by calling AddRoot three times -- once with "D:\cacheRoot", once with "E:\cacheRoot", and once with "F:\cacheRoot".

More Information and Examples

(AutoIt) Large Persistent Hash Table Stored on Filesystem (Classic ASP) Large Persistent Hash Table Stored on Filesystem (PowerBuilder) Large Persistent Hash Table Stored on Filesystem (SQL Server) Large Persistent Hash Table Stored on Filesystem (VBScript) Large Persistent Hash Table Stored on Filesystem (Visual Basic 6.0) Large Persistent Hash Table Stored on Filesystem (Visual FoxPro) Large Persistent Hash Table Stored on Filesystem

DeleteAll

DeleteAll() As Long

Deletes all items in the cache. This method completely clears the cache. All files in the cache are deleted. (If the cache is multi-level, existing sub-directories are not deleted.)

Returns the number of items (i.e. cache files) deleted.

DeleteAllExpired

DeleteAllExpired() As Long

Deletes all expired items from the cache.

Returns the number of items (i.e. cache files) deleted.

DeleteFromCache

DeleteFromCache(key As String) As Long

Deletes a single item from the disk cache. Returns 0 if the item exists in cache but could not be deleted. Otherwise returns 1.

Returns 1 for success, 0 for failure.

DeleteOlderDt

DeleteOlderDt(dateTime As CkDateTime) As Long

The same as DeleteOlder, except the dateTime is passed as a CkDateTime.

DeleteOlderStr

DeleteOlderStr(dateTimeStr As String) As Long

The same as DeleteOlder, except the dateTimeStr is passed as a date/time in RFC822 format.

FetchBd

FetchBd(key As String, bd As ChilkatBinData) As Long

Introduced in version 9.5.0.91

Fetches an item from cache and returns in bd.

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns 1 for success, 0 for failure.

FetchFromCache

FetchFromCache(key As String) As Variant

Fetches an item from cache.

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

More Information and Examples

(Classic ASP) Facebook Download all Photos to Local Files (SQL Server) Facebook Download all Photos to Local Files (VBScript) Facebook Download all Photos to Local Files (Visual Basic 6.0) Facebook Download all Photos to Local Files (Visual FoxPro) Facebook Download all Photos to Local Files

FetchSb

FetchSb(key As String, sb As ChilkatStringBuilder) As Long

Introduced in version 9.5.0.91

Fetches a text item from the cache and returns in sb.

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns 1 for success, 0 for failure.

FetchText

FetchText(key As String) As String

Fetches a text item from the cache and returns it's text content.

The key may be any length and may include any characters. It should uniquely identify the cached item. (No two items in the cache should have the same key.)

Returns Nothing on failure

More Information and Examples

(AutoIt) Large Persistent Hash Table Stored on Filesystem (Classic ASP) Large Persistent Hash Table Stored on Filesystem (PowerBuilder) Large Persistent Hash Table Stored on Filesystem (SQL Server) Large Persistent Hash Table Stored on Filesystem (VBScript) Large Persistent Hash Table Stored on Filesystem (Visual Basic 6.0) Large Persistent Hash Table Stored on Filesystem (Visual FoxPro) Large Persistent Hash Table Stored on Filesystem

GetEtag

GetEtag(key As String) As String

Returns the eTag for an item in the cache.

Returns Nothing on failure

GetExpirationDt

GetExpirationDt(key As String) As CkDateTime

Returns the expiration date/time for an item in the cache as a CkDateTime object.

Returns Nothing on failure

GetExpirationStr

GetExpirationStr(url As String) As String

Returns the expiration date/time for an item in the cache in RFC822 string format.

Returns Nothing on failure

GetFilename

GetFilename(key As String) As String

Returns the absolute file path of the cache file associated with the key.

Returns Nothing on failure

GetRoot

GetRoot(ByVal index As Long) As String

Returns the directory path of the Nth cache root. (Indexing begins at 0.)

Returns Nothing on failure

IsCached

IsCached(key As String) As Long

Returns 1 if the item is found in the cache, otherwise returns 0.

SaveTextDt

SaveTextDt(key As String, expireDateTime As CkDateTime, eTag As String, itemTextData As String) As Long

The same as SaveText, except the expire date/time is passed as a CkDateTime object.

Returns 1 for success, 0 for failure.

SaveTextNoExpire

SaveTextNoExpire(key As String, eTag As String, itemTextData As String) As Long

Inserts or replaces an text item in the cache with no expiration date/time. The eTag is optional and may be set to a zero-length string. Applications may use it as a place to save additional information about the cached item.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) Large Persistent Hash Table Stored on Filesystem (Classic ASP) Large Persistent Hash Table Stored on Filesystem (PowerBuilder) Large Persistent Hash Table Stored on Filesystem (SQL Server) Large Persistent Hash Table Stored on Filesystem (VBScript) Large Persistent Hash Table Stored on Filesystem (Visual Basic 6.0) Large Persistent Hash Table Stored on Filesystem (Visual FoxPro) Large Persistent Hash Table Stored on Filesystem

SaveTextStr

SaveTextStr(key As String, expireDateTime As String, eTag As String, itemTextData As String) As Long

The same as SaveText, except the expire date/time is passed as a string in RFC822 format.

Returns 1 for success, 0 for failure.

SaveToCacheDt

SaveToCacheDt(key As String, expireDateTime As CkDateTime, eTag As String, itemData As Variant) As Long

The same as SaveToCache, except the expire date/time is passed as a CkDateTime object.

Returns 1 for success, 0 for failure.

SaveToCacheNoExpire

SaveToCacheNoExpire(key As String, eTag As String, itemData As Variant) As Long

Inserts or replaces an item in the cache. The cached item will have no expiration. The eTag is optional and may be set to a zero-length string. Applications may use it as a place to save additional information about the cached item.

Returns 1 for success, 0 for failure.

More Information and Examples

(Classic ASP) Facebook Download all Photos to Local Files (SQL Server) Facebook Download all Photos to Local Files (VBScript) Facebook Download all Photos to Local Files (Visual Basic 6.0) Facebook Download all Photos to Local Files (Visual FoxPro) Facebook Download all Photos to Local Files

SaveToCacheStr

SaveToCacheStr(key As String, expireDateTime As String, eTag As String, itemData As Variant) As Long

The same as SaveToCache, except the expire date/time is passed in RFC822 string format.

Returns 1 for success, 0 for failure.

UpdateExpirationDt

UpdateExpirationDt(key As String, expireDateTime As CkDateTime) As Long

The same as UpdateExpiration, except the expireDateTime is passed as a CkDateTime.

Returns 1 for success, 0 for failure.

UpdateExpirationStr

UpdateExpirationStr(key As String, expireDateTime As String) As Long

The same as UpdateExpiration, except the expireDateTime is passed in RFC822 string format.

Returns 1 for success, 0 for failure.