OpenWGA 7.10 - TMLScript reference
WGAMethod :
selectDerivate([context,] fileName, derivateQuery)
| On object | WGA |
| Usage | Selects a file derivate of a file attachment which is the best match for a derivate query |
| Description |
This will execute the specified derivate query to find a derivate of the also specified file on the context document. If matching derivates are found it returns the metadata of the best matching derivate. If not it returns null. The context document is either retrieved from the context specified as parameter "context" or the context of of the script. |
| Parameters |
context (TMLContext, optional): A context document whose file should be queried for the derivates instead of the script context fileName (String): Name of the file on the context document to query for derivates derivateQuery (String): The derivate query |
| Return value | A WGAPI file derivate metadata object if a derivate was found, null otherwise. |
| Allowed in script types |
|