LlStgsysGetJobOptionStringEx Method

In This Topic

ProjectParameters from a preview file can be queried hereby.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Shared Function LlStgsysGetJobOptionStringEx( _
   ByVal hStg As IntPtr, _
   ByVal pszKey As String _
) As String

public static string LlStgsysGetJobOptionStringEx( 
   IntPtr hStg,
   string pszKey
)

public:
static String^ LlStgsysGetJobOptionStringEx( 
   IntPtr hStg,
   String^ pszKey
)

Parameters

hStg: The handle returned from LlStgsysStorageOpen().
pszKey: Name of the project parameter to be queried. The prefix "ProjectParameter." must be used for the call.

Return Value

Returns the value of the queried project parameter pszKey as string.

Example

A project parameter is queried directly from a preview file below.

// Create new project parameter
ProjectParameter projectParameter = LL.ProjectParameters.NewParameter("MyParamName");
projectParameter.ParameterType = LlProjectParameterType.Value;
projectParameter.Value = "MyParamValue";
projectParameter.SaveDefaultValue = true;
LL.ProjectParameters.Add(projectParameter);

// Additional code (Calling the Designer, create preview file...)
// ...

// Query the project parameter from the preview file
PreviewFile previewFile = new PreviewFile(@"C:\temp\sample.ll");
MessageBox.Show(LlCore.LlStgsysGetJobOptionStringEx(previewFile.Handle, "ProjectParameter." + projectParameter.Name));

VB.NET

' Create new project parameter
Dim projectParameter As ProjectParameter = LL.ProjectParameters.NewParameter("MyParamName")
projectParameter.ParameterType = LlProjectParameterType.Value
projectParameter.Value = "MyParamValue"
projectParameter.SaveDefaultValue = True
LL.ProjectParameters.Add(projectParameter)

' Additional code (Calling the Designer, create preview file...)
' ...

' Query the project parameter from the preview file
Dim previewFile As New PreviewFile("C:\temp\sample.ll")
MessageBox.Show(LlCore.LlStgsysGetJobOptionStringEx(previewFile.Handle, "ProjectParameter." + projectParameter.Name))

Requirements

Platforms: Windows 10 (Version 21H2 - 23H2), Windows 11 (21H2 - 22H2), Windows Server 2016 - 2022
.NET: .NET Framework 4.8, .NET 6, .NET 7, .NET 8

Reference

LlCore Class
LlCore Members
LlProjectParameterScope Enumeration
ProjectParameters Class
GetProjectParameterValue Method

Send Feedback