ecl-logo Documentation

ObjectToFilePath

ObjectToFilePath[objects]objectStrings

converts objects to formatted strings compatible for use in unique filepaths.

Details

    Input
    Output
    General Options
    Messages
  • MissingObjectsNot all the provided objects exist in the database. Check `1`

Examples

Basic Examples  (4)

Convert an object to a lowercase string:

Use ObjectToFilePath to construct a file path:

Convert objects in any form to a list of strings:

Convert an object to a string and back:

Options  (5)

Lowercase  (1)

Indicate that the id should be left in its original mixed-case state:

OutputFormat  (2)

Indicate that the object string should include the type:

Indicate that the object string should include the id prefix:

SpecialCharacter  (2)

Indicate that $ should be used to distinguish special characters:

Indicate that ( should be used to distinguish special characters:

Messages  (1)

MissingObjects  (1)

Print a message and return $Failed if any of the objects provided are not in the database:

Possible Issues  (1)

An object string can only be converted back to an object without performing string replacements when Lowercase->False and OutputFormat -> String: