L_EpnGetPrinterMailMessageInfo

#include "l_eprint.h"

L_INT EXT_FUNCTION L_EpnGetPrinterMailMessageInfo (pszPrinterName, pMailMessage, uSize, puNeeded)

L_CHAR L_FAR * pszPrinterName;

/* printer name */

BYTE L_FAR * pMailMessage;

/* mail message buffer */

L_UINT uSize;

/* size in bytes, of the buffer pointed to by pMailMessage */

L_UINT L_FAR * puNeeded;

/* bytes received or required */

Receives the mail message information of an ePrint printer.

Parameter

Description

pszPrinterName

Character string that contains the name of the ePrint printer.

pMailMessage

Pointer to a buffer that receives an EPNMAILMESSAGEINFO structure that contains the mail message information of the ePrint printer. The buffer should be large enough to receive the structure and any data to which the structure members point. If the buffer is too small, the puNeeded parameter returns the required buffer size.

uSize

Size in bytes, of the buffer pointed to by pMailMessage.

puNeeded

Pointer to a variable to be updated with the size of the retrieved mail message information, in bytes. If uSize is smaller than this value, L_EpnGetPrinterMailMessageInfo fails, and the value will represent the required buffer size. If uSize is equal to or greater than this value, L_EpnGetPrinterMailMessageInfo succeeds, and the value will represent the number of bytes stored in the buffer.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Support for Basic functionality must be unlocked by calling the L_EpnUnlockSupport function before using this function.

The user should first get the required size of the file save options for the specified printer, by passing NULL for pMailMessage, 0 for uSize, and a valid pointer for puNeeded. The function will return the ERROR_MORE_DATA error code and the required size in the puNeeded parameter. Next, allocate the pMailMessage buffer with the required size returned in puNeeded, and then recall the function with the valid data.

To use the retrieved pMailMessage pointer, it should be cast as pEPNMAILMESSAGEINFO.

Required DLLs and Libraries

LPKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to ePrint Files.

See Also

Functions:

L_EpnInstallOEMPrinter, L_EpnSetPrinterSaveOptions, L_EpnSetPrinterMailMessageInfo, L_EpnSetPrinterEmailConfiguration

Topics:

ePrint: Getting and Setting Printer Specification

 

Setting and Getting ePrint Printer Settings

Example

For an example, refer to L_EpnGetPrinterSaveOptions.