File BradyPrintSdkPrintJob.h

FileList > BradyPrintSdkPrintJob.h

Print job creation, page management, and submission for the Brady Desktop Print SDK.

#include "BradyPrintSdkCore.h"

Public Functions

Type	Name
BRADY_SDK_EXPORT BradySdkStatus	AddPageToPrintJob (PrinterHandle printer, PrintJobHandle jobHandle, const unsigned char * pageData, size_t dataSize) Adds page data to an existing print job.
BRADY_SDK_EXPORT BradySdkStatus	CreatePrintJob (PrinterHandle printer, const char * printJobName, PrintJobHandle * jobHandle) Creates a new print job for the specified printer.
BRADY_SDK_EXPORT BradySdkStatus	DestroyPrintJob (PrinterHandle printer, PrintJobHandle jobHandle) Destroys a print job and frees associated resources. This function should be called after a print job is sent or if it is no longer needed to free resources.
BRADY_SDK_EXPORT BradySdkStatus	SendPrintJob (PrinterHandle printer, PrintJobHandle jobHandle) Sends a print job to the printer.

Public Functions Documentation

function AddPageToPrintJob

Adds page data to an existing print job.

BRADY_SDK_EXPORT BradySdkStatus AddPageToPrintJob (
    PrinterHandle printer,
    PrintJobHandle jobHandle,
    const unsigned char * pageData,
    size_t dataSize
)

Parameters:

printer The handle to the connected printer instance.
jobHandle The handle to the print job to which the page should be added.
pageData A pointer to a byte array containing the page data. This must be a complete 1-bit per pixel monochrome BMP file loaded into memory (including the standard BITMAPFILEHEADER and BITMAPINFOHEADER).
dataSize The size of the pageData array in bytes.

Returns:

BRADY_SDK_SUCCESS if the page was added successfully.

See also: PrintJobHandle

See also: BradySdkStatus

function CreatePrintJob

Creates a new print job for the specified printer.

BRADY_SDK_EXPORT BradySdkStatus CreatePrintJob (
    PrinterHandle printer,
    const char * printJobName,
    PrintJobHandle * jobHandle
)

Parameters:

printer The handle to the connected printer instance.
printJobName A user-specified reference name for the print job.
jobHandle A pointer to a PrintJobHandle that will be set to the new job's handle. The handle will be valid until the job is sent or destroyed.

Returns:

BRADY_SDK_SUCCESS if the job was created successfully.

See also: PrintJobHandle

See also: BradySdkStatus

function DestroyPrintJob

Destroys a print job and frees associated resources. This function should be called after a print job is sent or if it is no longer needed to free resources.

BRADY_SDK_EXPORT BradySdkStatus DestroyPrintJob (
    PrinterHandle printer,
    PrintJobHandle jobHandle
)

Parameters:

printer The handle to the connected printer instance.
jobHandle The handle to the print job to destroy.

Returns:

BRADY_SDK_SUCCESS if the job was destroyed successfully.

See also: PrintJobHandle

See also: BradySdkStatus

function SendPrintJob

Sends a print job to the printer.

BRADY_SDK_EXPORT BradySdkStatus SendPrintJob (
    PrinterHandle printer,
    PrintJobHandle jobHandle
)

Parameters:

printer The handle to the connected printer instance.
jobHandle The handle to the print job to send.

Returns:

BRADY_SDK_SUCCESS if the job was sent successfully.

See also: PrintJobHandle

See also: BradySdkStatus

The documentation for this class was generated from the following file BradyPrintSdkPrintJob.h