Namespace: Consultingwerk.Windows.ListAndLabel
Class 
LlApiAnsi Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Windows.ListAndLabel.LlApi
Consultingwerk.Windows.ListAndLabel.LlApiAnsi

Inherits: Consultingwerk.Windows.ListAndLabel.LlApi


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ INTEGER DefineField (integer, character, character) Defines a list field and it's content
Overrides Consultingwerk.Windows.ListAndLabel.LlApi:DefineField (integer, character, character)
+ INTEGER DefineField2 (integer, character, character) Defines a list field and it's content
Overrides Consultingwerk.Windows.ListAndLabel.LlApi:DefineField2 (integer, character, character)
+ INTEGER DefineFieldExt (integer, character, character, integer, integer) Defines a list field and it's content
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER DefineFieldExt2 (integer, character, character, integer, integer) Defines a list field and it's content
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ DefineFieldStart (integer) Clears the internal field buffer to clear outdated definitions
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER DefineLayout (integer, integer, character, integer, character) Calls the interactive Designer that will be displayed as a modal pop-up window overlapping your application window.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER DefineVariable (integer, character, character) Defines a List and Label variable
Overrides Consultingwerk.Windows.ListAndLabel.LlApi:DefineVariable (integer, character, character)
+ INTEGER DefineVariable2 (integer, character, character) Defines a List and Label variable
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER DefineVariableExt (integer, character, character, integer, integer) Defines an extended variable
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER DefineVariableExt2 (integer, character, character, integer, integer) Defines an extended variable
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ DefineVariableStart (integer) Clears the internal variable buffer to clear outdated definitions
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ JobClose (integer) Closes a List & Label job
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER JobOpen (integer) Opens a List & Label Job
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PreviewDeleteFiles (integer, character, character) Deletes the temporary file(s) which have been created by the preview print.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PreviewDisplay (integer, character, character, integer) Starts the preview window.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PreviewSetTempPath (integer, character) Sets the temporary path for preview files
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER Print (integer) Output of all objects on the printer.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintEnd (integer, integer) Ends the print job
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintFields (integer) Output of a table line
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintFieldsEnd (integer) Ends the output of table lines
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintGetOption (integer, integer) Returns the various print options which are set by the user in the LlPrintOptionsDialog()
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ CHARACTER PrintGetOptionString (integer, integer) Returns various print option string settings.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintOptionsDialog (integer, integer, character) Calls a print option selection window and enables the user to select print-specific settings.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintOptionsDialogTitle (integer, integer, character, character) Calls a print option selection window and enables the user to select print-specific settings.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintResetProjectState (integer) Resets the project state for printing
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintSetBoxText (integer, character, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintSetOption (integer, integer, integer) Sets various print options for the print job or the print options dialog, for example to preset the number of copies required.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintSetOptionString (integer, integer, character) Sets various print options for List & Label
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER PrintWithBoxStart (integer, integer, character, integer, integer, integer, character) Starts the print job and opens the project file. Supports an abort window.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER SelectFileDlgTitleEx (integer, integer, character, integer, memptr, integer, integer) Opens a file select dialog with an integrated preview window
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER SetOption (integer, integer, integer) Sets diverse options in List & Label
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER SetOptionString (integer, integer, character) Sets string options in List & Label
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER SetPrinterToDefault (integer, integer, character) Sets the printer to default for a specific object
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ CHARACTER XGetParameter (integer, integer, character, character) Gets parameters from a specific extension module
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
+ INTEGER XSetParameter (integer, integer, character, character, character) Sets parameters in a specific extension module.
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi


Method Detail
Top

PUBLIC INTEGER DefineField (integer, character, character)
Overrides Consultingwerk.Windows.ListAndLabel.LlApi:DefineField (integer, character, character)
Purpose: Defines a list field and it's content
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineField2 (integer, character, character)
Overrides Consultingwerk.Windows.ListAndLabel.LlApi:DefineField2 (integer, character, character)
Purpose: Defines a list field and it's content
Notes: Ensures lpbufContents is not ?

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineFieldExt (integer, character, character, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Defines a list field and it's content
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
lPara INTEGER
The type of the field
lpPtr INTEGER
Reserved for future enhancements
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineFieldExt2 (integer, character, character, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Defines a list field and it's content
Notes: Ensures lpbufContents is not ?

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
lPara INTEGER
The type of the field
lpPtr INTEGER
Reserved for future enhancements
Returns INTEGER
Error code
Top

PUBLIC DefineFieldStart (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Clears the internal field buffer to clear outdated definitions
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
Top

PUBLIC INTEGER DefineLayout (integer, integer, character, integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Calls the interactive Designer that will be displayed as a modal
pop-up window overlapping your application window.
Notes: The window handle is used to deactivate the calling program.
If this is not desired or possible, NULL can also be passed. In this
case the calling program is responsible for closing the layout editor,
should the user abort the main program. This is not recommended.
When the List & Label layout Designer is minimized, the calling program
is also automatically minimized; when the Designer is subsequently restored,
List & Label is also restored.

Parameters:
hLlJob INTEGER
List & Label job handle
hWnd INTEGER
Handle of the application window which will be disabled while the Designer is being displayed.
pszTitle CHARACTER
Window title
nObjType INTEGER
Project type
pszObjName CHARACTER
The name of the layout file
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineVariable (integer, character, character)
Overrides Consultingwerk.Windows.ListAndLabel.LlApi:DefineVariable (integer, character, character)
Purpose: Defines a List and Label variable
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineVariable2 (integer, character, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Defines a List and Label variable
Notes: Ensures lpbufContents is not ?

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineVariableExt (integer, character, character, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Defines an extended variable
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
lPara INTEGER
The type of the variable
lpPtr INTEGER
Reserved for future enhancements
Returns INTEGER
Error code
Top

PUBLIC INTEGER DefineVariableExt2 (integer, character, character, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Defines an extended variable
Notes: Ensures lpbufContents is not ?

Parameters:
hLlJob INTEGER
The List & Label Job reference
pszVarName CHARACTER
The Field Name
lpbufContents CHARACTER
The Field Value
lPara INTEGER
The type of the variable
lpPtr INTEGER
Reserved for future enhancements
Returns INTEGER
Error code
Top

PUBLIC DefineVariableStart (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Clears the internal variable buffer to clear outdated definitions
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
Top

PUBLIC JobClose (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Closes a List & Label job
Notes:

Parameters:
hLlJob INTEGER
The List & Label Job reference
Top

PUBLIC INTEGER JobOpen (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Opens a List & Label Job
Notes: Almost all List & Label API's need the return value of this method
as a parameter

Parameters:
nLanguage INTEGER
The language for the List & Label UI
Returns INTEGER
The Job handle or job number
Top

PUBLIC INTEGER PreviewDeleteFiles (integer, character, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Deletes the temporary file(s) which have been created by the preview print.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
pszObjName CHARACTER
Valid file name without path name!
pszPath CHARACTER
Valid path of the preview files ending with a backslash "\".
Returns INTEGER
Error code
Top

PUBLIC INTEGER PreviewDisplay (integer, character, character, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Starts the preview window.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
pszObjName CHARACTER
Valid file name without path name!
pszPath CHARACTER
Valid path of the preview files ending with a backslash "\".
hWnd INTEGER
Window handle of the calling program
Returns INTEGER
Error code
Top

PUBLIC INTEGER PreviewSetTempPath (integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets the temporary path for preview files
Notes: This function sets the directory where temporary preview files
will be stored during preview operations.

Parameters:
hLlJob INTEGER
List & Label job handle
pszPath CHARACTER
Path to the temporary directory
Returns INTEGER
Error code
Top

PUBLIC INTEGER Print (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Output of all objects on the printer.
Notes: Normal objects and the header of a table object (see option
LL_OPTION_DELAYTABLEHEADER) are printed. A table object has to be
filled with calls of LlPrintFields() afterwards. LlPrint is responsible
for a page break.
Label/card projects: As long as LlPrint() returns LL_WRN_REPEAT_DATA,
LlPrint() must be called again, so objects that have caused a page break
must be printed again on the next label /page.
This function is described explicitly in the chapter "Further Programming
Basics"

Parameters:
hLlJob INTEGER
List & Label job handle
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintEnd (integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Ends the print job
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nPages INTEGER
Number of empty pages desired after the print
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintFields (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Output of a table line
Notes: With the return value LL_WRN_REPEAT_DATA, List & Label informs you
that you have to start a new page for the entry. With the corresponding
LlPrint() on the next page the record pointer should not be moved to
the next record.
If more tables are added via LlDbAddTable() the return value also can
be LL_WRN_TABLECHANGE. Please refer to chapter "5.5. Printing
Relational Data" for further information.

Parameters:
hLlJob INTEGER
List & Label job handle
Returns INTEGER
Error code or command
Top

PUBLIC INTEGER PrintFieldsEnd (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Ends the output of table lines
Notes: This function should be called after all table data has been output
with LlPrintFields() calls to finalize the table printing process.

Parameters:
hLlJob INTEGER
List & Label job handle
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintGetOption (integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Returns the various print options which are set by the user in the
LlPrintOptionsDialog()
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nIndex INTEGER
LL_PRNOPTSTR_EXPORT, LL_PRNOPTSTR_ ISSUERANGES, LL_PRNOPTSTR_ PAGERANGES, LL_PRNOPTSTR_PRINTDST_FILENAME, LL_PRNOPTSTR_PRINTJOBNAME,
Returns INTEGER
Setting chosen by the user
Top

PUBLIC CHARACTER PrintGetOptionString (integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Returns various print option string settings.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nIndex INTEGER
Returns CHARACTER
The Option Value
Top

PUBLIC INTEGER PrintOptionsDialog (integer, integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Calls a print option selection window and enables the user to select
print-specific settings.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
hWnd INTEGER
Window handle of the calling program
lpszText CHARACTER
Text to be passed in the dialog, e.g. 'Only 55 labels will be printed'
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintOptionsDialogTitle (integer, integer, character, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Calls a print option selection window and enables the user to select
print-specific settings.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
hWnd INTEGER
Window handle of the calling program
lpszTitle CHARACTER
Dialog title
lpszText CHARACTER
Text to be passed in the dialog, e.g. 'Only 55 labels will be printed'
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintResetProjectState (integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Resets the project state for printing
Notes: This function resets the internal project state to allow for
restarting the print process without reopening the job.

Parameters:
hJob INTEGER
List & Label job handle
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintSetBoxText (integer, character, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose:
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
lpszText CHARACTER
Text which should appear in the box
nPercentage INTEGER
Progress percentage
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintSetOption (integer, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets various print options for the print job or the print options
dialog, for example to preset the number of copies required.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nIndex INTEGER
LL_PRNOPTSTR_EXPORT, LL_PRNOPTSTR_ ISSUERANGES, LL_PRNOPTSTR_ PAGERANGES, LL_PRNOPTSTR_PRINTDST_FILENAME, LL_PRNOPTSTR_PRINTJOBNAME,
nValue INTEGER
Sets the option corresponding to the nIndex
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintSetOptionString (integer, integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets various print options for List & Label
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nIndex INTEGER
LL_PRNOPT_COPIES, LL_PRNOPT_PAGE, LL_PRNOPT_OFFSET, LL_PRNOPT_FIRSTPAGE, LL_PRNOPT_LASTPAGE, LL_PRNOPT_PRINTDLG_ONLYPRINTERCOPIES, LL_PRNOPT_UNITS
pszBuffer CHARACTER
The new value
Returns INTEGER
Error code
Top

PUBLIC INTEGER PrintWithBoxStart (integer, integer, character, integer, integer, integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Starts the print job and opens the project file. Supports an abort
window.
Notes:

Parameters:
hLlJob INTEGER
Job handle
nObjType INTEGER
LL_PROJECT_LABEL, LL_PROJECT_LIST or LL_PROJECT_CARD
pszObjName CHARACTER
The file name of the project
nPrintOptions INTEGER
Print options, like LL_PRINT_NORMAL, LL_PRINT_PREVIEW, LL_PRINT_FILE, LL_PRINT_EXPORT
nBoxType INTEGER
The dialog type
hWnd INTEGER
Window handle of the calling program (used as parent of the dialog box)
pszTitle CHARACTER
Title of the abort dialog box, also appears as text in the print manager
Returns INTEGER
Error code
Top

PUBLIC INTEGER SelectFileDlgTitleEx (integer, integer, character, integer, memptr, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Opens a file select dialog with an integrated preview window
Notes:

Parameters:
hLlJob INTEGER
Job handle
hWnd INTEGER
The handle of the parent window
pszTitle CHARACTER
The title for the dialog
nObjType INTEGER
The list and label object type, LL_PROJECT_LABEL, LL_PROJECT_CARD, LL_PROJECT_LIST
pszObjName MEMPTR
INPUT-OUTPUT The object name to select
nBufSize INTEGER
The size of the object name buffer
pReserved INTEGER
Reserved for future use
Returns INTEGER
Error code
Top

PUBLIC INTEGER SetOption (integer, integer, integer)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets diverse options in List & Label
Notes: Please call this function before LlDefineLayout() and before the
functions LlPrint...Start(), preferably directly after LlJobOpen()/
LlJobOpenLCID().

Parameters:
hLlJob INTEGER
List & Label job handle
nMode INTEGER
Mode index
nValue INTEGER
New value
Returns INTEGER
Error code
Top

PUBLIC INTEGER SetOptionString (integer, integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets string options in List & Label
Notes: Most of the options need to be set before LlDefineLayout()and before
the functions LlPrint...Start(), preferably directly after LlJobOpen()/
LlJobOpenLCID(). If an option needs to be set at a different time,
this will be stated in that option's description.

Parameters:
hLlJob INTEGER
List & Label job handle
nMode INTEGER
Mode index
pcValue CHARACTER
New value
Returns INTEGER
Error code
Top

PUBLIC INTEGER SetPrinterToDefault (integer, integer, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets the printer to default for a specific object
Notes: This function resets the printer settings to the default printer
for the specified object type and name.

Parameters:
hLlJob INTEGER
List & Label job handle
nObjType INTEGER
Object type (LL_PROJECT_LABEL, LL_PROJECT_LIST, LL_PROJECT_CARD)
pszObjName CHARACTER
Object name
Returns INTEGER
Error code
Top

PUBLIC CHARACTER XGetParameter (integer, integer, character, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Gets parameters from a specific extension module
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nExtensionType INTEGER
Type of extension, LL_LLX_EXTENSIONTYPE_EXPORT, LL_LLX_EXTENSIONTYPE_BARCODE
pszExtensionName CHARACTER
Name of the extension ("HTML", "RTF", "PDF417", ...)
pszKey CHARACTER
Name of the parameter
Returns CHARACTER
The value of the parameter
Top

PUBLIC INTEGER XSetParameter (integer, integer, character, character, character)
Inherited from Consultingwerk.Windows.ListAndLabel.LlApi
Purpose: Sets parameters in a specific extension module.
Notes:

Parameters:
hLlJob INTEGER
List & Label job handle
nExtensionType INTEGER
Type of extension, LL_LLX_EXTENSIONTYPE_EXPORT, LL_LLX_EXTENSIONTYPE_BARCODE
pszExtensionName CHARACTER
Name of the extension ("HTML", "RTF", "PDF417", ...)
pszKey CHARACTER
Name of the parameter
pszValue CHARACTER
Value of the parameter
Returns INTEGER
Error code


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.01.2026 08:27:45