Command.GetLdcObject Method

Returns the value for an entry from the jobs' LDC (local data collection).

Syntax

BegFunc GetLdcObject Access(*Public) Type(*String)
   DclSrParm name Type (*String)       

Parameters

name
The name of the object whose value is to be returned.

Return Value

A string containing a value for the named entry from the jobs' local data collection.

Exceptions

The following exceptions may be encountered during the execution of this method.

Value Condition
MonarchJobEndedException The Monarch Job has ended in an exception.
MonarchJobUnavailableException There is no Monarch Job available to accept commands.

Remarks

he LDC can contain any type of object, however only those that are of type String can be sent to the Yellow side.

To access the LDC strong values from the Yellow side use this method with the following syntax

  • public string GetLdcObject( string name )

This command can be executed only when the Job is waiting in either of these states:

  • Waiting for input from the user (in a READ or EXFMT of a display file)
  • Accepting Commands via the AcceptCommand method on MonarchJob

Example

DclFld Command Type(ASNA.Monarch.Command) New(*Base.Context)
DclFld CompanyName Type(*String)
   CompanyName = Command.GetLdcObject("CompanyName")

Requirements

Namespace: ASNA.Monarch.WebDspF

Assembly: ASNA.Monarch.WebDspF.DLL

Platforms: Windows Server 2012, Windows Server 2012 R2, Windows Server 2016, Windows 7, Windows 8 Pro, Windows 10 Pro