6.1-roAssetPoolFiles

ON THIS PAGE


 Object Creation: The roAssetPoolFiles object is created with two parameters.

CreateObject("roAssetPoolFiles", pool As Object, assets As Object)

The "assets" can be either an roAssetCollection or roSyncSpec object. If more than one object requires use of the roAssetCollection object, it will be more efficient to convert roSyncSpec to roAssetCollection by calling GetAssets() once and then passing that collection to all objects requiring it.

This object works similarly to the roSyncPoolFiles object.

ifAssetPoolFiles

GetFailureReason() As String

Returns explanatory text if GetPoolFilePath() returns an empty string or GetPoolFileInfo() returns Invalid.

GetPoolFilePath(asset_name As String) As String

Looks up the specified file name in the asset collection and uses the information to determine the actual name of the file in the pool. This method returns an empty string if the name is not found in the asset collection, or if the file is not found in the pool.

GetPoolFileInfo(asset_name As String) As Object

Looks up the specified file name in the asset collection and returns all available information, including the pool file path, as an associative array. This method returns Invalid if the asset name is not found in the asset collection. If the file is not found in the pool, information from the asset collection will be returned without the pool path. See the table below for a description of assets in the associative array.

Field

Value

Description

name

String

Asset name

link

String

Asset URL

size

String

 

hash

String

Hash in algorithm ":" hash format

change_hint

String

Only present if set

auth_user

String

Only present if set

auth_password

String

Only present if set

auth_inherit

Boolean

 

headers_inherit

Boolean

 

probe

String

Probe data

path

String

Absolute path of the file in the pool (or "invalid" if the file is not in the pool)