Cache ActiveX Reference Documentation

Cache

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatCache

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

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

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

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

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

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

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

Properties

DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastEtagFetched As String (read-only)

The ETag of the last item fetched from cache.

LastExpirationFetched As Date (read-only)

This property is deprecated. It will be removed in a future version.

Expiration date/time of the last item fetched from cache.

LastExpirationFetchedStr As String (read-only)

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

LastHitExpired As Long (read-only)

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

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 As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

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 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 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 As String (read-only)

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

Methods

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".

(Classic ASP) Facebook Download all Photos to Local Files

(Visual FoxPro) Facebook Download all Photos to Local Files

(PowerBuilder) Facebook Download all Photos to Local Files

(SQL Server) Facebook Download all Photos to Local Files

(Visual Basic 6.0) Facebook Download all Photos to Local Files

(VBScript) Facebook Download all Photos to Local Files

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() As Long

Deletes all expired items from the cache.

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

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.

DeleteOlder(ByVal dateTime As Date) As Long

This method is deprecated. It will be removed in a future version.

Deletes all items older than a specified date/time.

Returns the number of items (i.e. cache files) deleted. Returns -1 on error.

DeleteOlderDt(dateTime As CkDateTime) As Long

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

DeleteOlderStr(dateTimeStr As String) As Long

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

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.

(Classic ASP) Facebook Download all Photos to Local Files

(Visual FoxPro) Facebook Download all Photos to Local Files

(PowerBuilder) Facebook Download all Photos to Local Files

(SQL Server) Facebook Download all Photos to Local Files

(Visual Basic 6.0) Facebook Download all Photos to Local Files

(VBScript) Facebook Download all Photos to Local Files

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

(Classic ASP) Facebook Download all Photos to Local Files

(Visual FoxPro) Facebook Download all Photos to Local Files

(PowerBuilder) Facebook Download all Photos to Local Files

(SQL Server) Facebook Download all Photos to Local Files

(Visual Basic 6.0) Facebook Download all Photos to Local Files

(VBScript) Facebook Download all Photos to Local Files

GetEtag(key As String) As String

Returns the eTag for an item in the cache.

Returns Nothing on failure

GetExpiration(key As String) As Date

This method is deprecated. It will be removed in a future version.

Returns the expire date/time for an item in the cache.

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(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(key As String) As String

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

Returns Nothing on failure

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(key As String) As Long

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

SaveText(key As String, ByVal expireDateTime As Date, eTag As String, itemTextData As String) As Long

This method is deprecated. It will be removed in a future version.

Inserts or replaces an text item in the cache. 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. 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.

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(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.

(Classic ASP) Facebook Download all Photos to Local Files

(Visual FoxPro) Facebook Download all Photos to Local Files

(PowerBuilder) Facebook Download all Photos to Local Files

(SQL Server) Facebook Download all Photos to Local Files

(Visual Basic 6.0) Facebook Download all Photos to Local Files

(VBScript) Facebook Download all Photos to Local Files

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.

SaveToCache(key As String, ByVal expireDateTime As Date, eTag As String, itemData As Variant) As Long

This method is deprecated. It will be removed in a future version.

Inserts or replaces an item in the cache. 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. (The Chilkat HTTP component, when caching a page, writes the eTag (entity-tag) from the HTTP response header to this field.)

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.

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(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.

(Classic ASP) Facebook Download all Photos to Local Files

(Visual FoxPro) Facebook Download all Photos to Local Files

(PowerBuilder) Facebook Download all Photos to Local Files

(SQL Server) Facebook Download all Photos to Local Files

(Visual Basic 6.0) Facebook Download all Photos to Local Files

(VBScript) Facebook Download all Photos to Local Files

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.

UpdateExpiration(key As String, ByVal expireDateTime As Date) As Long

This method is deprecated. It will be removed in a future version.

Updates the expire date/time for a cached item.

Returns 1 for success, 0 for failure.

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(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.