IKPrintStartDoc

This function starts the print job.

[C++Builder/Visual C++] BOOL IKPrintStartDoc(HDC hDC, HWND hWnd, LPCTSTR Caption, LPCTSTR Message, LPCTSTR ButtonName, LPCTSTR DocName);

[Delphi] function IKPrintStartDoc(hDC: HDC; hWnd: HWND; Caption, Message, ButtonName, DocName: PChar): LongBool;

[Visual Basic] Function IKPrintStartDoc(ByVal hDC As Long, ByVal hWnd As Long, ByVal Caption As String, ByVal Message As String, ByVal ButtonName As String, ByVal DocName As String) As Long

Parameters

Name	Explanation
hDC	The device context retrieved by the IKPrintDlg or IKPrintCreateDC functions
hWnd	The window handle
Caption	The caption in the Cancel Printing dialog
Message	The message displayed in the center of the Cancel Printing dialog
ButtonName	The button name in the Cancel Printing dialog
DocName	The name of the document to be printed

Return Value

Returns True (nonzero) if successful. Returns False (0) if unsuccessful.

Explanation

The IKPrintStartDoc function starts the print job. If the Caption, Message, and Button parameters are blank then the Progress dialog box is not displayed. This function should be used with the IKPrintStartPage, IKPrintEndPage, and IKPrintEndDoc functions. Please refer to the sample code in the IKPrintCreateDC and IKPrintDlg functions.

The differences from the ImageKit5

Function Name	Parameters
IK5PrintStartDoc:	hWnd, Caption, Message, ButtonName, PrintFileName
IKPrintStartDoc:	hDC, hWnd, Caption, Message, ButtonName, DocName

In the ImageKit5 the name of the document to be printed was taken from the Message parameter. In the ImageKit8, the name of the document to be printed is provided by the DocName parameter.

In the ImageKit5, the device context was returned, but in the ImageKit8 whether this function is successful or not is returned. In the ImageKit8 the IKPrintDlg or the IKPrintCreateDC can be used to retrieve the device context.