MsSna_PrintSession Class

A base class for a print session on a Print service.

The following syntax is simplified from MOF code.

Syntax

  
class MsSna_PrintSession : MsSna_Config  
{  
   String Name;  
   String Service;  
   String Comment;  
   String StatusText;  
   sint16 Activation;  
   sint16 CodePage;  
   sint16 CodePageLanguage;  
   String PrinterDeviceName;  
   String CodePageCustomFile;   
   String PrinterFile;  
   boolean PrintToFile;  
   String FaceName;  
   boolean FaceNameOverride;  
   sint32 LeftMargin;  
   sint32 RightMargin;  
   sint32 TopMargin;  
   sint32 BottomMargin;  
   boolean MarginOverride;  
   boolean UniqueExtension;  
   String PDTFile;  
   boolean CheckPDTFile;  
   String Filter;  
   boolean bFilter;  
   sint16 FontSize;  
   sint16 SessionType;  
   sint16 LinesPerInch;  
   sint16 CharsPerLine;  
   boolean IgnoreTransparentSections;  
   boolean NoHorizontalScaling;  
   boolean NoVerticalScaling;  
   boolean LPIOverride;  
   boolean PageSetupOverride;  
};  

Parameters

Name
Data Type: String Qualifiers: Key, MAXLEN(32), TOUPPERCASEAccess Type: Read/Write

The session name, which distinguishes different printers on the network.

Service
Data Type: String Qualifiers: MAXLEN(20)Access Type: Read/Write

The SNA service to which the print session belongs.

Comment
Data Type: String Qualifiers: MAXLEN(25)Access Type: Read/Write

An optional comment field.

StatusText
Data Type: String Access Type: Read/Write

The status of the print session.

Activation
Data Type: String Access Type: Read/Write

The print session activation. The following table describes the possible values for Activation.

CodePage
Data Type: sint16Access Type: Read/Write

A value that indicates whether a standard language code or a custom code page will be used. The following table describes the possible values for CodePage.

CodePageLanguage
Data Type: sint16Access Type: Read/Write

The code page to be used in the print session. For more information about the possible values for CodePageLanguage, see the Remarks section.

PrinterDeviceName
Data Type: String Qualifiers: MAXLEN(256)Access Type: Read/Write

The name of the destination printer.

CodePageCustomFile
Data Type: String Qualifiers: MAXLEN(256)Access Type: Read/Write

The file name if a custom code page is to be used.

PrinterFile
Data Type: String Qualifiers: MAXLEN(256)Access Type: Read/Write

The name of the file. Valid only when printing to a file.

PrintToFile
Data Type: Boolean Access Type: Read/Write

true to indicate that the print job will be sent to a file; otherwise, false. Note that you must still configure a destination printer.

FaceName
Data Type: String Qualifiers: MAXLEN(31)Access Type: Read/Write

The name of the face.

FaceNameOverride
Data Type: Boolean Access Type: Read/Write

true to override the host commands; otherwise, false.

LeftMargin
Data Type: sint32 Qualifiers: MINVALUE(0), MAXVALUE(255)Access Type: Read/Write

The left margin, in inches.

RightMargin
Data Type: sint32 Qualifiers: MINVALUE(0), MAXVALUE(255) Access Type: Read/Write

The right margin, in inches.

TopMargin
Data Type: String Qualifiers: MINVALUE(0), MAXVALUE(255) Access Type: Read/Write

The top margin, in inches.

BottomMargin
Data Type: sint32 Qualifiers: MINVALUE(0), MAXVALUE(255)Access Type: Read/Write

The bottom margin, in inches.

MarginOverride
Data Type: Boolean Access Type: Read/Write

true to override the host margin commands; otherwise, false.

UniqueExtension
Data Type: Boolean Access Type: Read/Write

true to instruct the print service to give each file a unique extension when printing a file.

PDTFile
Data Type: String Qualifiers: MAXLEN(256)Access Type: Read/Write

A PDT file used to format the print job.

CheckPDTFile
Data Type: Boolean Access Type: Read/Write

true to indicate that a PDT file will be used to format the print job; otherwise, false.

Filter
Data Type: String Qualifiers: MAXLEN(256)Access Type: Read/Write

The filter DLL to be used to filter the printer data stream.

bFilter
Data Type: Boolean Qualifiers: QualiferValueHere Access Type: Read/Write

true to indicate that a filter DLL will be used to filter the printer data stream; otherwise, false.

FontSizeOverride
Data Type: Boolean Access Type: Read/Write

true to override the host font size commands.

FontSize
Data Type: sint16 Qualifiers: MINVALUE(0), MAXVALUE(3276) Access Type: Read/Write

The font size to be used when printing.

SessionType
Data Type: sint16 Access Type: Read/Write

A value that indicates whether this is an APPC or 3270 print session. The following table describes the possible values for SessionType.

LinesPerInch
Data Type: sint16 Qualifiers: MINVALUE(1), MAXVALUE(12) Access Type: Read/Write

The number of lines per inch to be printed.

CharsPerLine
Data Type: sint16 Access Type: Read/Write

The number of characters per line to be printed.

IgnoreTransparentSections
Data Type: Boolean Access Type: Read/Write

true to ignore sections of the print data stream that have been marked as Transparent; otherwise, false. This value is valid only when using a PDT file to format the data.

NoHorizontalScaling
Data Type: Boolean Access Type: Read/Write

true to turn off the horizontal scaling feature of the printer driver; otherwise, false.

NoVerticalScaling
Data Type: Boolean Access Type: Read/Write

true to turn off the vertical scaling feature of the printer driver; otherwise, false.

LPIOverride
Data Type: Boolean Access Type: Read/Write

true to enable host commands for lines per inch to be overridden; otherwise, false.

PageSetupOverride
Data Type: String Access Type: Read/Write

The override for the page setup.

Remarks

The following table describes the possible values for CodePageLanguage.

Requirements

Platforms: Windows Server 2022, Windows Server 2019, Windows Server 2016, Windows 11, and Windows 10

See Also

WMISNA WMI Provider Classes
Administration and Management Programmer's Guide