combit List & Label 24 - .NET Online Web Help
LlStgsysStorageOpen Method


combit.ListLabel24 Namespace > LlCore Class : LlStgsysStorageOpen Method

The name of the project or preview (List & Label does not care about the extension as it will always be set to .LL)

a temporary path (can be null or empty)

Value Meaning
true

The file will be opened in read-only mode.

false

The file can be written to

Value Meaning
true

the Stgsys API takes care about multiple jobs and

shows you all data as one job.

false

You can (and must!) manage multiple jobs yourself

Opens a preview file.  

You should avoid calling this API directly. The PreviewFile Class offers you a much more powerful way to work with preview files.

Syntax
'Declaration
 
Public Shared Function LlStgsysStorageOpen( _
   ByVal filename As String, _
   ByVal tempPath As String, _
   ByVal readOnly As Boolean, _
   ByVal oneJobTranslation As Boolean _
) As IntPtr
public static IntPtr LlStgsysStorageOpen( 
   string filename,
   string tempPath,
   bool readOnly,
   bool oneJobTranslation
)
public:
static IntPtr LlStgsysStorageOpen( 
   String^ filename,
   String^ tempPath,
   bool readOnly,
   bool oneJobTranslation
) 

Parameters

filename

The name of the project or preview (List & Label does not care about the extension as it will always be set to .LL)

tempPath

a temporary path (can be null or empty)

readOnly
Value Meaning
true

The file will be opened in read-only mode.

false

The file can be written to

oneJobTranslation
Value Meaning
true

the Stgsys API takes care about multiple jobs and

shows you all data as one job.

false

You can (and must!) manage multiple jobs yourself

Return Value

Job-Handle for all others LlStgsys functions, 0 means error

Remarks

If you use a path for temporary data, this will be used as directory of the preview files, else the path of the project file name will be used. This convention is compatible with the calls to LlPrint(<Project file>) and LlPreviewSetTempPath(<Temporary Path>). Note that the functions LlStgsysAppend and LlStgsysSetPageOptionString need the file to be opened with bReadOnly = false! oneJobTranslation = true is handy if you don??t want to care about multiple jobs. If you want to show your users whether the file contains multiple jobs, you need to set this to false and manage a list of jobs with their properties.

Requirements

Platforms: Windows Vista - Windows 10 Version 1809, Windows Server 2008 - 2016

See Also

Reference

LlCore Class
LlCore Members