Label Printer SDK for iOS ■ Table of Contents 1. About This Manual ......................4 ...................... 4 1-1 Supported iOS Version ..................4 1-2 List of Supported Printer / Interface ....................5 1-3 List of Supported Methods 2. Constants ........................9 ........................
This SDK Manual contains the description of the library API that is required for the development of iOS application programs. BIXOLON makes continuous improvements to functions and qualities of products, and specifications and contents of this manual are subject to change without prior notice for this reason.
Label Printer SDK for iOS 2. Constants Constants used in the provided SDK are defined in the “LabelPrinterSDK_Defines.h” file. 2-1 Result Codes Results Codes are the values returned from various methods, which indicate error conditions of the corresponding method. typedef enum{ _SDK_RESULT_SUCCESS = 0x0000, _SDK_RESULT_FAIL...
Label Printer SDK for iOS 2-2 Alignment Alignment constants are used to specify the alignment property. typedef enum{ _SDK_ALIGNMENT_LEFT = 0, _SDK_ALIGNMENT_RIGHT = 1, _SDK_ALIGNMENT_CENTER = 2, _SDK_ALIGNMENT_STRING_FROM_RIGHT_2_LEFT = 2, }__SDK_ALIGNMENTS; Description of each constant is as follows. Code Value Description _SDK_ALIGNMENT_LEFT Align to left...
Label Printer SDK for iOS 2-3 Barcode HRI Barcode HRI (Human Readable Interpretation) constant is used to specify the position and font of HRI when printing barcodes that support HRI. typedef enum{ _SDK_BARCODE_HRI_NONE = 0, _SDK_BARCODE_HRI_BELOW_FONTSIZE1 = 1, _SDK_BARCODE_HRI_ABOVE_FONTSIZE1 = 2, _SDK_BARCODE_HRI_BELOW_FONTSIZE2 = 3, _SDK_BARCODE_HRI_ABOVE_FONTSIZE2...
Label Printer SDK for iOS 2-4 MaxiCode Modes MaxiCode Mode constants are used to set the barcode option when printing Mexi code barcode. typedef enum{ _SDK_MAXICODE_MODE_0 = 0, _SDK_MAXICODE_MODE_2 = 2, _SDK_MAXICODE_MODE_3 = 3, _SDK_MAXICODE_MODE_4 = 4, }__SDK_MAXICODE_MODE; Description of each constant is as follows. Code Value Description...
Label Printer SDK for iOS 2-6 Barcode Origin Point Barcode Origin Point constants are used to set the reference origin position of barcode. typedef enum{ _SDK_BARCODE_ORIGIN_POINT_CENTER = 0, _SDK_BARCODE_ORIGIN_POINT_UpperLeft = 1, }__SDK_BARCODE_ORIGIN_POINT; Description of each constant is as follows. Code Value Description Set the reference point of the...
Label Printer SDK for iOS 2-8 Data Compression Method Data Compression Method constants are used to specify the data compression property. typedef enum{ _SDK_DATA_COMPRESSION_METHOD_TEXT = 0, _SDK_DATA_COMPRESSION_METHOD_NUMERIC = 1, _SDK_DATA_COMPRESSION_METHOD_BINARY = 2, }__SDK_DATA_COMPRESSION_METHOD; Description of each constant is as follows. Code Value Description...
Label Printer SDK for iOS 2-11 Codablock Mode Codablock Mode constants are used to set the options when printing Codablock barcode. typedef enum{ _SDK_CODABLACK_MODE_A = 'A', _SDK_CODABLACK_MODE_E = 'E', _SDK_CODABLACK_MODE_F = 'F', }__SDK_CODABLACK_MODE; Description of each constant is as follows. Code Value Description...
Label Printer SDK for iOS 2-13 RSS Barcode Type RSS Barcode Type constants are used to set the barcode type when printing RSS barcode. typedef enum{ _SDK_RSS_BARCODE_TYPE_RSS14 = 0, _SDK_RSS_BARCODE_TYPE_RSS14_TRUNCATED = 1, _SDK_RSS_BARCODE_TYPE_RSS14_STACKED = 2, _SDK_RSS_BARCODE_TYPE_RSS14_STACKED_OMNIDIRECTIONAL = 3, _SDK_RSS_BARCODE_TYPE_RSS_LIMITED = 4, _SDK_RSS_BARCODE_TYPE_RSS_EXPANDED = 5, _SDK_RSS_BARCODE_TYPE_UPC_A...
Label Printer SDK for iOS 2-14 Rotation Degrees Rotation Degrees constants are used to set the rotation property of the printing. typedef enum{ _SDK_ROTATION_DEGREES_0 = 0, _SDK_ROTATION_DEGREES_90 = 1, _SDK_ROTATION_DEGREES_180 = 2, _SDK_ROTATION_DEGREES_270 = 3, }__SDK_ROTATION_DEGREES; Description of each constant is as follows. Code Value Description...
Label Printer SDK for iOS 2-16 Vector Fonts Vector Fonts constants are used to set the property of Vector Fonts. typedef enum { _SDK_VECTOR_FONT_ASCII ='U', _SDK_VECTOR_FONT_KS5601 ='K', _SDK_VECTOR_FONT_BIG5 ='B', _SDK_VECTOR_FONT_GB2312 ='G', _SDK_VECTOR_FONT_SHIFT_JIS ='J', _SDK_VECTOR_FONT_OCR_A ='a', _SDK_VECTOR_FONT_OCR_B ='b', }_SDK_VECTOR_FONT; Description of each constant is as follows. Code Value Description...
Label Printer SDK for iOS 2-18 Draw Circle Sizes Draw Circle Sizes constants are used to set the property related to the size when using the Draw Circle Method. typedef enum { _SDK_DRAW_CIRCLE_SIZE_40X40 = 1, // 5(mm) diameter _SDK_DRAW_CIRCLE_SIZE_56X56 = 2, _SDK_DRAW_CIRCLE_SIZE_72X72 = 3, _SDK_DRAW_CIRCLE_SIZE_88X88...
Label Printer SDK for iOS 2-19 International Character Set These constants are used to set the International Character Set. typedef enum { _SDK_CONFIG_ICS_USA = 0, _SDK_CONFIG_ICS_FRANCE = 1, _SDK_CONFIG_ICS_GERMANY = 2, _SDK_CONFIG_ICS_UK = 3, _SDK_CONFIG_ICS_DENMARK_I = 4, _SDK_CONFIG_ICS_SWEDEN = 5, _SDK_CONFIG_ICS_ITALY = 6, _SDK_CONFIG_ICS_SPAIN_I...
Label Printer SDK for iOS 2-20 Code Pages These constants are used to set the Code Page. typedef enum { _SDK_CONFIG_CODEPAGE_CP437 = 0, _SDK_CONFIG_CODEPAGE_CP850 = 1, _SDK_CONFIG_CODEPAGE_CP852 = 2, _SDK_CONFIG_CODEPAGE_CP860 = 3, _SDK_CONFIG_CODEPAGE_CP863 = 4, _SDK_CONFIG_CODEPAGE_CP865 = 5, _SDK_CONFIG_CODEPAGE_CP81252 = 6, _SDK_CONFIG_CODEPAGE_CP865_WCP1252 = 7, _SDK_CONFIG_CODEPAGE_CP857...
Page 25
Label Printer SDK for iOS Description of each constant is as follows. Code Value _SDK_CONFIG_CODEPAGE_CP437 CP437 U.S.A _SDK_CONFIG_CODEPAGE_CP850 CP850 Latin1 _SDK_CONFIG_CODEPAGE_CP852 CP 852 Latin2 _SDK_CONFIG_CODEPAGE_CP860 CP 860 Portuguese Canadian _SDK_CONFIG_CODEPAGE_CP863 CP 863 French _SDK_CONFIG_CODEPAGE_CP865 CP 865 Nordic _SDK_CONFIG_CODEPAGE_CP1252 WCP 1252 Latin I CP 865 + European...
Label Printer SDK for iOS 3. LabelPrinterSDK Class Reference Inherits from NSObject Framework libLabelPrinterSDK.a LabelPrinterSDK.h Declared 3-1 Overview libLabelPrinterSDK Class is the main object that controls the printer operation. 3-2 Methods 3-2-1 open This method initializes the settings to use the LabelPrinterSDK class. [Syntax] -(long) open;...
WiFi Printer: Enter the IP Address. Bluetooth Printer: Enter the Mac Address. port : Enter the communication port of the printer. Communication port of the BIXOLON printers is 9100. Bluetooth printers are not supported. [Return Value] Upon successful operation, _SDK_RESULT_SUCCESS will be returned.
Label Printer SDK for iOS 3-2-6 disconnectWithTimeout This method disconnects the printer within the specified Timeout period. [Syntax] -(long) disconnectWithTimeout:(NSInteger)timeout; [Parameters] timeout Set the Timeout period. (Unit: Second) [Return Value] Upon successful operation, _SDK_RESULT_SUCCESS will be returned. Refer to the 2-1 Result Codes for more details on other result codes.
Label Printer SDK for iOS 3-2-9 getDrawBlockOptions This method gets information and string values declared in relation to Draw Block Options in NSMutableArray data type. [Syntax] -(NSMutableArray*) getDrawBlockOptions; [Return Value] “nil” will be returned if the operation fails. [See Also] 2-17 Draw Block Options 3-2-10 getDrawCicleSizes This method gets information and string values declared in relation to Draw Circle Sizes...
Label Printer SDK for iOS 3-2-12 getBarcodeHRI This method gets information and string values declared in relation to Barcode HRI in NSMutableArray data type. [Syntax] -(NSMutableArray*) getBarcodeHRI; [Return Value] “nil” will be returned if the operation fails. [See Also] 2-3 1D Barcode HRI 3-2-13 doPrint This method prints the contents stored in the output buffer of the printer.
Label Printer SDK for iOS 3-2-14 drawTextDeviceFont This method requests the printing of text string to the image buffer using the Device Fonts. [Syntax] -(long) drawTextDeviceFont:(NSString*)text xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion fontSelection:(char)fontSelection fontWidth:(NSInteger)fontWidth fontHeight:(NSInteger)fontHeight rightSideCharacterSpacing:(NSInteger)rightSideCharacterSpacing fontRotation:(NSInteger)fontRotation reverse:(BOOL)reverse bold:(BOOL)bold textAlignment:(NSInteger)textAlignment; [Parameters] text Text string to print. xPosition X coordinate of the position to print yPosition...
Page 32
Label Printer SDK for iOS [Return Value] Upon successful operation, _SDK_RESULT_SUCCESS will be returned. Refer to the 2-1 Result Codes for more details on other result codes. [Discussion] When textAlignment is set to _SDK_ALIGNMENT_CENTER, it has the same effect as the _SDK_ALIGNMENT_STRING_FROM_RIGHT_2_LEFT option. Nothing will be printed when this API is called.
Label Printer SDK for iOS 3-2-15 drawTextVectorFont This method requests the printing of text string to the image buffer using the Vector Fonts. [Syntax] -(long) drawTextVectorFont:(NSString*)text xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion fontSelection:(char)fontSelection fontWidth:(NSInteger)fontWidth fontHeight:(NSInteger)fontHeight rightSideCharacterSpacing:(NSInteger)rightSideCharacterSpacing fontRotation:(NSInteger)fontRotation reverse:(BOOL)reverse bold:(BOOL)bold italic:(BOOL)italic textWriteDirectionRightToLeft:(BOOL)textWriteDirectionRightToLeft textAlignment:(NSInteger)textAlignment; [Parameters] text Text string to print xPosition X coordinate of the position to print...
Page 34
Label Printer SDK for iOS [Return Value] Upon successful operation, _SDK_RESULT_SUCCESS will be returned. Refer to the 2-1 Result Codes for more details on other result codes. [Discussion] When textAlignment is set to _SDK_ALIGNMENT_STRING_FROM_RIGHT_2_LEFT, it has the same effect as the _SDK_ALIGNMENT_CENTER option. Nothing will be printed when this API is called.
Label Printer SDK for iOS 3-2-16 drawBarcode1D This method requests the printing of 1D barcode to the image buffer. [Syntax] -(long) drawBarcode1D:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion barcodeType:(NSInteger)barcodeType widthNarrow:(NSInteger)widthNarrow widthWide:(NSInteger)widthWide height:(NSInteger)height hri:(NSInteger)hri quietZoneWidth:(NSInteger)quietZoneWidth rotation:(NSInteger)rotation; [Parameters] text Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print barcodeType...
Label Printer SDK for iOS 3-2-17 drawBarcodeMaxiCode This method requests the printing of MaxiCode barcode to the image buffer. [Syntax] -(long) drawBarcodeMaxiCode:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion mode:(NSInteger)mode; [Parameters] text Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print mode Mode of MaxiCode (Reference:...
Label Printer SDK for iOS 3-2-18 drawBarcodePDF417 This method requests the printing of PDF417 barcode to the image buffer. [Syntax] -(long) drawBarcodePDF417:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion maximumRowCount:(NSInteger)maximumRowCount // 3~90 maximumColumnCount:(NSInteger)maximumColumnCount // 1~30 errorCorrectionLevel:(NSInteger)errorCorrectionLevel dataCompressionMethod:(NSInteger)dataCompressionMethod printBarcodeText:(BOOL)printBarcodeText barcodeOriginPoint:(NSInteger)barcodeOriginPoint moduleWidth:(NSInteger)moduleWidth // 2~9 barHeight:(NSInteger)barHeight // 4~99 rotation:(NSInteger)rotation;...
Page 38
Label Printer SDK for iOS [Return Value] Upon successful operation, _SDK_RESULT_SUCCESS will be returned. Refer to the 2-1 Result Codes for more details on other result codes. [Discussion] Nothing will be printed when this API is called. Contents requested by this API will be printed when 3-2-13 doPrint API is called.
Label Printer SDK for iOS 3-2-19 drawBarcodeQRCode This method requests the printing of QRCode barcode to the image buffer. [Syntax] -(long) drawBarcodeQRCode:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion barcodeSize:(NSInteger)barcodeSize // 1~4 model:(NSInteger)model errorColectionLevel:(NSInteger)errorColectionLevel rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print barcodeSize...
Label Printer SDK for iOS 3-2-20 drawBarcodeDataMatrix This method requests the printing of Data Matrix barcode to the image buffer. [Syntax] -(long) drawBarcodeDataMatrix:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion barcodeSize:(NSInteger)barcodeSize // 1~4 reverse:(BOOL)reverse rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print barcodeSize...
Label Printer SDK for iOS 3-2-21 drawBarcodeAztec This method requests the printing of Aztec barcode to the image buffer. [Syntax] -(long) drawBarcodeAztec:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion barcodeSize:(NSInteger)barcodeSize // 1~10 extendedChannel:(BOOL)extendedChannel errorCorrectionLevel:(NSInteger)errorCorrectionLevel menuSymbol:(BOOL)menuSymbol numberOfSymbols:(NSInteger)numberOfSymbols optionalID:(NSString*)optionalID rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print...
Page 42
Label Printer SDK for iOS [Return Value] Upon successful operation, _SDK_RESULT_SUCCESS will be returned. Refer to the 2-1 Result Codes for more details on other result codes. [Discussion] Nothing will be printed when this API is called. Contents requested by this API will be printed when 3-2-13 doPrint API is called.
Label Printer SDK for iOS 3-2-22 drawBarcodeCode49 This method requests the printing of Code49 barcode to the image buffer. [Syntax] -(long)drawBarcodeCode49:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion widthNarrow:(NSInteger)widthNarrow widthWide:(NSInteger)widthWide height:(NSInteger)height hri:(NSInteger)hri startingMode:(NSInteger)startingMode rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print widthNarrow...
Label Printer SDK for iOS 3-2-23 drawBarcodeCodaBlock This method requests the printing of CodaBlock barcode to the image buffer. [Syntax] -(long) drawBarcodeCodaBlock:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion widthNarrow:(NSInteger)widthNarrow widthWide:(NSInteger)widthWide height:(NSInteger)height securityLevel:(BOOL)securityLevel numberOfCharactersPerrow:(NSInteger)numberOfCharactersPerrow mode:(char)mode numberOfRowToEncode:(NSInteger)numberOfRowToEncode; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print widthNarrow...
Label Printer SDK for iOS 3-2-24 drawBarcodeMicroPDF This method requests the printing of Micro PDF417 barcode to the image buffer. [Syntax] -(long) drawBarcodeMicroPDF:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion moduleWidth:(NSInteger)moduleWidth // 2~8 barcodeHeight:(NSInteger)barcodeHeight // 1~99 mode:(NSInteger)mode // 0~33 rotation:(NSInteger)rotation; [Parameters] text Barcode value to print xPosition X coordinate of the position to print yPosition...
Label Printer SDK for iOS 3-2-25 drawBarcodeIMB This method requests the printing of drawBarcodeIMB barcode to the image buffer. [Syntax] -(long) drawBarcodeIMB:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion printBarcodeText:(BOOL)printBarcodeText rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print printBarcodeText...
Label Printer SDK for iOS 3-2-26 drawBarcodeMSI This method requests the printing of drawBarcodeMSI barcode to the image buffer. [Syntax] -(long) drawBarcodeMSI:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion widthNarrow:(NSInteger)widthNarrow widthWide:(NSInteger)widthWide height:(NSInteger)height checkDigitSelection:(NSInteger)checkDigitSelection printCheckDigitInHRI:(BOOL)printCheckDigitInHRI hri:(NSInteger)hri rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print widthNarrow...
Label Printer SDK for iOS 3-2-27 drawBarcodePlessey This method requests the printing of drawBarcodePlessey barcode to the image buffer. [Syntax] -(long) drawBarcodePlessey:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion widthNarrow:(NSInteger)widthNarrow widthWide:(NSInteger)widthWide height:(NSInteger)height printCheckDigit:(BOOL)printCheckDigit hri:(NSInteger)hri rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print widthNarrow...
Label Printer SDK for iOS 3-2-28 drawBarcodeTLC39 This method requests the printing of drawBarcodeTLC39 barcode to the image buffer. [Syntax] -(long) drawBarcodeTLC39:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion widthNarrow:(NSInteger)widthNarrow widthWide:(NSInteger)widthWide height:(NSInteger)height rowHeightOfMicroPDF417:(NSInteger)rowHeightOfMicroPDF417 narrowWidthOfMicroPDF417:(NSInteger)narrowWidthOfMicroPDF417 rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition Y coordinate of the position to print widthNarrow...
Label Printer SDK for iOS 3-2-29 drawBarcodeRSS This method requests the printing of drawBarcodeRSS barcode to the image buffer. [Syntax] -(long) drawBarcodeRSS:(NSString*)data xPosition:(NSInteger)xPostion yPosition:(NSInteger)yPostion barcodeType:(NSInteger)barcodeType magnification:(NSInteger)magnification // 1~10 separatorHeight:(NSInteger)separatorHeight // 1~2 barcodeHeight:(NSInteger)barcodeHeight segmentWidth:(NSInteger)segmentWidth // 0~22 rotation:(NSInteger)rotation; [Parameters] data Barcode value to print xPosition X coordinate of the position to print yPosition...
Label Printer SDK for iOS 4-1-2 Printing Contents START General Initialize … (Declare ~ Connect) Reference: 4-1-1 General General Initialize // [USE] Functions to print barcode, text, image, and various shapes can be used. Long lResult = [_printer drawImage: _imageSample.image stratPosX:100 startPosY:100 width:300];...
Label Printer SDK for iOS 4-1-3 Printing Two or More Contents on One Side START General Initialize … (Declare ~ Connect) Reference : 4-1-1 General General Initialize // [Contents 1] Long lResult = [_printer drawImage: _imageSample.image stratPosX:100 startPosY:100 width:300]; if(lResult = _SDK_RESULT_SUCCESS) NSLog(@”drawImage Success”);...
Label Printer SDK for iOS 4-2 Sample Codes 4-2-1 Connecting/Disconnecting // Declaration/Allocation and open SDK LabelPrinterSDK _printer = [LabelPrinterSDK new]; [_printer open]; // Connect to the printer that is connected with IP Address “10.0.0.1” and Port 9100 long lResult = [_printer connectWithAddress:@”10.0.0.1” port:@”9100”]; if(lResult == _SDK_RESULT_SUCCESS) NSLog(@”Connect Success”);...
Label Printer SDK for iOS 4-2-4 Printing a Circle to the Image Buffer lResult = [_printer drawCircle:200 startPosY:200 sizeSelection:_SDK_DRAW_CIRCLE_SIZE_40X40 multiplier:1]; if(lResult == _SDK_RESULT_SUCCESS) NSLog(@”drawTextDeviceFont Success”); 4-2-5 Printing a Text String with Device Font to the Image Buffer lResult = [_printer drawTextDeviceFont:@"device Font Test" xPosition:70 yPosition:220 fontSelection:_SDK_DEVICE_FONT_12PT fontWidth:1 fontHeight:1...
Label Printer SDK for iOS 4-3 Sample Application 4-3-1 Connect / Disconnect 1. Select to Interface 2. Input the MacAddress for target printer. 3. Connect to target printer. 4. Print to testPage. 5. Disconnect to targetPrinter. ※ Do not disconnect. If you want to use other Features.(print text, print Image, etc.) 4-3-2 Print to Device Font 1.
Label Printer SDK for iOS 4-3-3 Print Vector Font 1. Enter text to print. 2. X,Y coordinate of the position to print.(1~4) 3. Horizontal/Vertical magnification of the selected font (1~4). 4. Requests the printing of text string to the output buffer using the Device Fonts 5.
Label Printer SDK for iOS 4-3-5 Use to more features. 1. Block shapes can be used. 2. Circle shapes can be used. 3. 1D Barcodes can be used.. 4. 2D Barcodes can be used. 4-3-6 Print Rectangle. 1. X,Y coordinate of the position to print.(Left, Top) 2.
Label Printer SDK for iOS 4-3-7 Print Circle shapes. 1. X,Y coordinate of the position to print. 2. Enter size of circle.(1~4) 3. Store into output buffer 4. Print the contents stored in the output buffer of the printer. Rev. 1.04 - 64 -...
Need help?
Do you have a question about the SLP-DX420 and is the answer not in the manual?
Questions and answers