combit List & Label 25 - .NET Online Web Help
LlStgsysGetJobOptionStringEx Method
Example 


combit.ListLabel25 Namespace > LlCore Class : LlStgsysGetJobOptionStringEx Method
The handle returned from LlStgsysStorageOpen().
Name of the project parameter to be queried. The prefix "ProjectParameter." must be used for the call.
ProjectParameters from a preview file can be queried hereby.
Syntax
'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));
' 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 7 SP1 - Windows 10 Version 1909, Windows Server 2008 R2 - 2019

See Also

Reference

LlCore Class
LlCore Members
LlProjectParameterScope Enumeration
ProjectParameters Class
GetProjectParameterValue Method