Developer

API Reference

IBTBPPSender_SendDocument()

Brew Release
Brew MP 1.0.2
Description
Sends data to be printed to the printer.The application should not close the port until AEEBTBPP_EV_SEND_DOC_DONE is generated.
Parameters
  • _me
    [in]:
    the object
  • pszDocType
    [in]:
    The Document Format string includes the MIME media-type followed by an optional USASCII string, representing any applicable version of the data format.The MIME mediatype is separated from the version string with the colon character.
  • piDocPortList
    [in]:
    pointer to list of iPort1 objects from which data can be sent to the printer. The length of the list can be greater than one only if the document format is AEEBTBPP_DOC_FORMAT_VCARD or AEEBTBPP_DOC_FORMAT_VCALENDAR. When sending a series of vCard/vCal objects, each port may be used to send an object.
  • nNumPorts
    [in]:
    number of iPort1 objects in piDocPortList.
  • pszDocName
    [in]:
    optional, name of the document in UTF-8 format.
  • uObjectsPerPage
    [in]:
    valid if non zero.Optional document layout information. If Document Type is AEEBTBPP_DOC_FORMAT_VCARD ,this represents the number of vCards to be included per page when a stream of vCards is passed to the printer. If Document Type is AEEBTBPP_DOC_FORMAT_VCALENDAR, this is the number of vCalendar objects to be printed per page.
  • pszLayout
    [in]:
    Optional layout information for vCard objects. AEEBTBPP_VCARD_LAYOUT_BUSINESS AEEBTBPP_VCARD_LAYOUT_PHONEBOOK Optional layout information for vCalendar objects. AEEBTBPP_VCAL_LAYOUT_SINGLE AEEBTBPP_VCAL_LAYOUT_DAILY AEEBTBPP_VCAL_LAYOUT_WEEKLY AEEBTBPP_VCAL_LAYOUT_MONTHLY
  • pszDescriptor
    [in]:
    the application can choose to format the layout information itself, in UTF-8 format.If the descriptor is provided by the app, ObjectsPerPage, and pszLayout are ignored. For example, when sending vCard data to the printer, the description field can contain layout information.
  • Syntax
    []:
    <Parameter Name>Parameter Value</Parameter Name>
  • Example
    []:
    <CardsPerPage>16</CardsPerPage>
    The printer will interpret the document type before examining the contents of the description field.
  • uJobID
    [in]:
    should be zero for the simple print model. For Job based print, this is the Job ID obtained from the CreateJob SOAP response.
    Return
  • AEE_SUCCESS
    []:
    The operation has been scheduled,AEEBTBPP_EV_SEND_DOC_DONE will be generated when the operation completes.
  • AEE_EBADPARM
    []:
    invalid input parameters.
  • AEE_EBADSTATE
    []:
    not connected to a printer, or in the middle of another operation.
Interface
Prototype
   AEEResult IBTBPPSender_SendDocument(IBTBPPSender*  _me,
                                       const char*    pszDocType,
                                       IPort1**       piDocPortList,
                                       int            nNumPorts,
                                       const char*    pszDocName,
                                       unsigned int   uObjectsPerPage,
                                       const char*    pszLayout,
                                       const char*    pszDescriptor,
                                       unsigned int   uJobID)
Side Effect
None.
See Also : IBTBPPSender_CancelSendDocument
Comment
None.
  • Follow