publish::handle_binary_file (public)

 publish::handle_binary_file item_id revision_id_ref url_ref error_ref \
    [ args... ]

Defined in packages/acs-content-repository/tcl/publish-procs.tcl

Parameters:

item_id - The id of the item to handle
revision_id_ref - {required} The name of the variable in the calling frame that will receive the revision_id whose content blob was written to the filesystem.
url_ref - The name of the variable in the calling frame that will receive the relative URL of the file in the filesystem which contains the content blob
error_ref - The name of the variable in the calling frame that will receive an error message. If no error has occurred, this variable will be set to the empty string ""

Options:

-embed

Signifies that the content should be embedded directly in the parent item. -embed is required for this proc, since it makes no sense to handle the binary file in any other way.

-revision_id

{default The live revision for the item} The revision whose content is to be used

-no_merge

If present, do NOT merge with the template, in order to prevent infinite recursion in the <content> tag. In this case, the proc will return the empty string ""

Returns:

The HTML resulting from merging the item with its template, or "" if no template exists or the -no_merge flag was specified

See Also:

• publish::handle::image

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.