Share via


PosPrinterBase.SetLogo Method

2/27/2008

Saves a data string as the top or bottom logo.

Namespace: Microsoft.PointOfService.BaseServiceObjects
Assembly: Microsoft.PointOfService.ControlBase (in microsoft.pointofservice.controlbase.dll)

Syntax

'Declaration
Public Overrides Sub SetLogo ( _
    location As PrinterLogoLocation, _
    data As String _
)
public override void SetLogo (
    PrinterLogoLocation location,
    string data
)
public:
virtual void SetLogo (
    PrinterLogoLocation location, 
    String^ data
) override
public void SetLogo (
    PrinterLogoLocation location, 
    String data
)
public override function SetLogo (
    location : PrinterLogoLocation, 
    data : String
)

Parameters

  • location
    Where the logo is to be set. Possible values are defined by the PrinterLogoLocation enumeration as PrinterLogoLocation.Top or PrinterLogoLocation.Bottom.
  • data
    Logo data.

Remarks

The PosPrinterBase class verifies that the application has the device opened, claimed, and enabled. PosPrinterBase validates the parameters and device state, and may throw PosControlException exceptions with the following ErrorCode:

Value

Meaning

Illegal

The specified location isn’t PrinterLogoLocation.Top or PrinterLogoLocation.Bottom;

If no exception is thrown, the PosPrinterBase class sets the PosPrinterProperties.TopLogo or PosPrinterProperties.BottomLogo properties to the specified data; or

Once these properties are set, the service object should use their values for the top or bottom logos if the application specifies the appropriate escape sequence in calls to the PrintNormal, PrintTwoNormal, or PrintImmediate methods.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PosPrinterBase Class
PosPrinterBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
PosPrinter.PrintNormal Method
PosPrinter.PrintTwoNormal Method
PosPrinter.PrintImmediate Method