formZ SDK | 5.0 API Reference | System | System
Description
Adds an entry into the formZ pdf help .
Plugin Prototype
fzrt_error_td fz_syst_help_add_floc_entry(
uuid, | |
char * | description, |
pdf_path_floc, | |
char * | pdf_file_name, |
char * | pdf_destination, |
char * | title_string ) |
Parameters
uuid [Input]
The uuid of the tool, dialog, palette for which to set the help entry.
description [Input]
A description of tool, dialog, palette.
pdf_path_floc [Input]
An floc containing the full path to the pdf file. This is usually the same floc as the plugin.
pdf_file_name [Input]
The name of the pdf help file without the .pdf file extension. FormZ will add the language specifier and the .pdf file extension.
pdf_destination [Input]
The destination string from the pdf file describing which page to link to.
title_string [Input]
A string to display to the user identifying the section title in the pdf document.
Returns
Error codes
Availability
6.0.0.0
Function Set
Defined in