Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

This object works similarly to the roSyncPoolFiles object.

...

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

MoveFileIntoPool(source_filename As String, asset_name As String) As Boolean

Moves an arbitrary file into the appropriate location in the asset pool. The source file must be in the same filesystem as the asset pool. This method accepts two parameters:

  • [string] source_filename: The path of an existing file in the filesystem
  • [string] asset_name: The name of an asset within the asset collection associated with the roAssetPoolFiles instance. If the asset size is known, it will be checked against the source file. The move operation will fail if the asset_name does not match any asset in the pool or if the file size does not match the known asset size.

This method returns true on success and false on failure. Use the GetFailureReason() method to retrieve an error description.

GetPoolFilePath(asset_name As String) As String

...

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)