Difference between revisions of "MEDIA - Media path/URL/name (Reports & Settings Report Generator function)"
From Catalyst
(Updated from revision control) |
(Updated from revision control) |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
== Syntax == | == Syntax == | ||
− | '''$MEDIA'''{media_id, id, A/O, I/E, I/V/P/D/S/R/A, P/N} | + | '''$MEDIA'''{media_id, id, A/O, I/E, I/V/P/D/S/R/A, P/N, category} |
== Description == | == Description == | ||
Line 54: | Line 54: | ||
:;N | :;N | ||
::Name of the original file before it was copied/moved into the Platinum database (not applicable to video links). | ::Name of the original file before it was copied/moved into the Platinum database (not applicable to video links). | ||
+ | ;category | ||
+ | :A text parameter that can be omitted. | ||
+ | :The media category to include. This can be left blank to include all media categories. | ||
== Returns == | == Returns == |
Latest revision as of 05:37, 13 May 2021
Syntax
$MEDIA{media_id, id, A/O, I/E, I/V/P/D/S/R/A, P/N, category}
Description
Will get the associated file path, URL or name for the media.
This can be used in conjunction with image printer commands (e.g. '^{I filename'} with the built-in Platinum Windows printer driver) to include images on printed reports.
"^{I" + $MEDIA{media_id} + ",,25}" prints the default image (with a height of 25mm). |
Parameters
- media_id
- A text parameter that can not be omitted.
- The input media ID (10 character ID, see below) whose details you require.
- id
- A numeric parameter that can be omitted (it defaults to "0").
- The identification number of the media from 1 to 999. A value of 0, or if the parameter is omitted, will give the designated default/favourite media item for I/V/P/D/S/R/A.
- A/O
- A text parameter that can be omitted (it defaults to "A").
- A
- Actual ID.
- O
- Offset ID (Omits Default).
- I/E
- A text parameter that can be omitted (it defaults to "E").
- I
- Include non-published media.
- E
- Exclude non-published media.
- I/V/P/D/S/R/A
- A text parameter that can be omitted (it defaults to "I").
- I
- Image Files.
- V
- Video Links.
- P
- PDF/XPS Files.
- D
- Document Files.
- S
- Spreadsheet Files.
- R
- Presentation Files.
- A
- Audio Files.
- P/N
- A text parameter that can be omitted (it defaults to "P").
- P
- Path in the Platinum database of the stored file / video link URL.
- N
- Name of the original file before it was copied/moved into the Platinum database (not applicable to video links).
- category
- A text parameter that can be omitted.
- The media category to include. This can be left blank to include all media categories.
Returns
A text value. The media path/URL/name.