sean-m
/
Vanara
mirror of https://github.com/dahall/Vanara.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Added GDI Print Api Functions to Gdi32 and WinSpool

pull/83/head
David Hall 2019-12-14 16:30:28 -07:00
parent eb1bf547c2
commit 980e48a91d
4 changed files with 2241 additions and 257 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1757
PInvoke/Gdi32/WinGdi.Print.cs
View File

File diff suppressed because it is too large Load Diff

272
PInvoke/Printing/WinSpool.Enums.cs
View File

@ -15,55 +15,293 @@ namespace Vanara.PInvoke
{
/// <summary>Printing-specific authorization to cancel, pause, resume, or restart the job ([MS-DTYP] ACCESS_MASK Bit 27).</summary>
JOB_ACCESS_ADMINISTER = 0x00000010,
/// <summary>Printing-specific read rights for the spool file ([MS-DTYP] ACCESS_MASK Bit 26).<127></summary>
JOB_ACCESS_READ = 0x00000020,
/// <summary>Access rights for jobs combining RC (Read Control) of ACCESS_MASK with printing-specific JOB_ACCESS_ADMINISTER.
/// <para>This value MUST NOT be passed over the wire. If it is, the server SHOULD return ERROR_ACCESS_DENIED.</para></summary>
/// <summary>
/// Access rights for jobs combining RC (Read Control) of ACCESS_MASK with printing-specific JOB_ACCESS_ADMINISTER.
/// <para>This value MUST NOT be passed over the wire. If it is, the server SHOULD return ERROR_ACCESS_DENIED.</para>
/// </summary>
JOB_EXECUTE = ACCESS_MASK.STANDARD_RIGHTS_EXECUTE | JOB_ACCESS_ADMINISTER,
/// <summary>Access rights for jobs combining RC (Read Control) of ACCESS_MASK with printing-specific JOB_ACCESS_READ.</summary>
JOB_READ = ACCESS_MASK.STANDARD_RIGHTS_READ | JOB_ACCESS_READ,
/// <summary>Access rights for jobs combining RC (Read Control) of ACCESS_MASK with printing-specific JOB_ACCESS_ADMINISTER.
/// <para>This value MUST NOT be passed over the wire. If it is, the server SHOULD return ERROR_ACCESS_DENIED.</para></summary>
/// <summary>
/// Access rights for jobs combining RC (Read Control) of ACCESS_MASK with printing-specific JOB_ACCESS_ADMINISTER.
/// <para>This value MUST NOT be passed over the wire. If it is, the server SHOULD return ERROR_ACCESS_DENIED.</para>
/// </summary>
JOB_WRITE = ACCESS_MASK.STANDARD_RIGHTS_WRITE | JOB_ACCESS_ADMINISTER,
/// <summary>Access rights for printers to perform all administrative tasks and basic printing operations except SYNCHRONIZE ([MS-DTYP] ACCESS_MASK Bit 'SY'). Combines STANDARD_RIGHTS_REQUIRED (ACCESS_MASK Bits 'RC', 'DE', 'WD', 'WO'), JOB_ACCESS_ADMINISTER (ACCESS_MASK Bit 27), and JOB_ACCESS_READ (ACCESS_MASK Bit 26).</summary>
/// <summary>
/// Access rights for printers to perform all administrative tasks and basic printing operations except SYNCHRONIZE ([MS-DTYP]
/// ACCESS_MASK Bit 'SY'). Combines STANDARD_RIGHTS_REQUIRED (ACCESS_MASK Bits 'RC', 'DE', 'WD', 'WO'), JOB_ACCESS_ADMINISTER
/// (ACCESS_MASK Bit 27), and JOB_ACCESS_READ (ACCESS_MASK Bit 26).
/// </summary>
JOB_ALL_ACCESS = ACCESS_MASK.STANDARD_RIGHTS_REQUIRED | JOB_ACCESS_ADMINISTER | JOB_ACCESS_READ,
/// <summary>Printing-specific access rights for printers to perform administrative tasks ([MS-DTYP] ACCESS_MASK Bit 29).</summary>
PRINTER_ACCESS_ADMINISTER = 0x00000004,
/// <summary>Printing-specific access rights for printers to perform basic printing operations ([MS-DTYP] ACCESS_MASK Bit 28).</summary>
/// <summary>
/// Printing-specific access rights for printers to perform basic printing operations ([MS-DTYP] ACCESS_MASK Bit 28).
/// </summary>
PRINTER_ACCESS_USE = 0x00000008,
/// <summary>Printing-specific access rights for printers to perform printer data management operations ([MS-DTYP] ACCESS_MASK Bit 25).<128></summary>
/// <summary>Printing-specific access rights for printers to perform printer data management operations ([MS-DTYP] ACCESS_MASK
/// Bit 25).<128></summary>
PRINTER_ACCESS_MANAGE_LIMITED = 0x00000040,
/// <summary>Access rights for printers to perform all administrative tasks and basic printing operations except synchronization. Combines WO (Write Owner), WD (Write DACL), RC (Read Control), and DE (Delete) of ACCESS_MASK with printing-specific PRINTER_ACCESS_ADMINISTER and printing-specific PRINTER_ACCESS_USE.</summary>
/// <summary>
/// Access rights for printers to perform all administrative tasks and basic printing operations except synchronization.
/// Combines WO (Write Owner), WD (Write DACL), RC (Read Control), and DE (Delete) of ACCESS_MASK with printing-specific
/// PRINTER_ACCESS_ADMINISTER and printing-specific PRINTER_ACCESS_USE.
/// </summary>
PRINTER_ALL_ACCESS = ACCESS_MASK.STANDARD_RIGHTS_REQUIRED | PRINTER_ACCESS_ADMINISTER | PRINTER_ACCESS_USE,
/// <summary>Access rights for printers combining RC (Read Control) of ACCESS_MASK with printing-specific PRINTER_ACCESS_USE.</summary>
PRINTER_EXECUTE = ACCESS_MASK.STANDARD_RIGHTS_EXECUTE | PRINTER_ACCESS_USE,
/// <summary>Access rights for printers combining RC (Read Control) of ACCESS_MASK with printing-specific PRINTER_ACCESS_USE.</summary>
PRINTER_READ = ACCESS_MASK.STANDARD_RIGHTS_READ | PRINTER_ACCESS_USE,
/// <summary>Access rights for printers combining RC (Read Control) of ACCESS_MASK with printing-specific PRINTER_ACCESS_USE.</summary>
PRINTER_WRITE = ACCESS_MASK.STANDARD_RIGHTS_WRITE | PRINTER_ACCESS_USE,
/// <summary>Printing-specific access rights to administer print servers ([MS-DTYP] ACCESS_MASK Bit 31).</summary>
SERVER_ACCESS_ADMINISTER = 0x00000001,
/// <summary>Printing-specific access rights to enumerate print servers ([MS-DTYP] ACCESS_MASK Bit 30).</summary>
SERVER_ACCESS_ENUMERATE = 0x00000002,
/// <summary>Access rights for print servers to perform all administrative tasks and basic printing operations except synchronization. Combines WO (Write Owner), WD (Write DACL), RC (Read Control), and DE (Delete) of ACCESS_MASK with printing-specific SERVER_ACCESS_ADMINISTER and printing-specific SERVER_ACCESS_ENUMERATE.</summary>
/// <summary>
/// Access rights for print servers to perform all administrative tasks and basic printing operations except synchronization.
/// Combines WO (Write Owner), WD (Write DACL), RC (Read Control), and DE (Delete) of ACCESS_MASK with printing-specific
/// SERVER_ACCESS_ADMINISTER and printing-specific SERVER_ACCESS_ENUMERATE.
/// </summary>
SERVER_ALL_ACCESS = ACCESS_MASK.STANDARD_RIGHTS_REQUIRED | SERVER_ACCESS_ADMINISTER | SERVER_ACCESS_ENUMERATE,
/// <summary>Access rights for print servers combining RC (Read Control) of ACCESS_MASK with printing-specific SERVER_ACCESS_ENUMERATE.</summary>
SERVER_EXECUTE = ACCESS_MASK.STANDARD_RIGHTS_EXECUTE | SERVER_ACCESS_ENUMERATE,
/// <summary>Access rights for print servers combining RC (Read Control) of ACCESS_MASK with printing-specific SERVER_ACCESS_ENUMERATE.</summary>
SERVER_READ = ACCESS_MASK.STANDARD_RIGHTS_READ | SERVER_ACCESS_ENUMERATE,
/// <summary>Access rights for print servers combining RC (Read Control) of ACCESS_MASK with printing-specific SERVER_ACCESS_ADMINISTER and printing-specific SERVER_ACCESS_ENUMERATE.</summary>
/// <summary>
/// Access rights for print servers combining RC (Read Control) of ACCESS_MASK with printing-specific SERVER_ACCESS_ADMINISTER
/// and printing-specific SERVER_ACCESS_ENUMERATE.
/// </summary>
SERVER_WRITE = ACCESS_MASK.STANDARD_RIGHTS_WRITE | SERVER_ACCESS_ADMINISTER | SERVER_ACCESS_ENUMERATE,
}
/// <summary>Specifies additional information about the print job.</summary>
[PInvokeData("wingdi.h", MSDNShortId = "329bf0d9-399b-4f64-a029-361ef7558aeb")]
public enum DI
/// <summary>The capabilities to be queried.</summary>
[PInvokeData("wingdi.h", MSDNShortId = "d7f63ef7-0a2e-47c3-9e81-6e8a6dffe9af")]
public enum DC : uint
{
/// <summary>Applications that use banding should set this flag for optimal performance during printing.</summary>
DI_APPBANDING = 0x00000001,
/// <summary>
/// Returns the dmFields member of the printer driver's DEVMODE structure. The dmFields member indicates which members in the
/// device-independent portion of the structure are supported by the printer driver.
/// </summary>
DC_FIELDS = 1,
/// <summary>The application will use raster operations that involve reading from the destination surface.</summary>
DI_ROPS_READ_DESTINATION = 0x00000002
/// <summary>
/// Retrieves a list of supported paper sizes. The pOutput buffer receives an array of WORD values that indicate the available
/// paper sizes for the printer. The return value indicates the number of entries in the array. For a list of the possible array
/// values, see the description of the dmPaperSize member of the DEVMODE structure. If pOutput is NULL, the return value
/// indicates the required number of entries in the array.
/// </summary>
DC_PAPERS = 2,
/// <summary>
/// Retrieves the dimensions, in tenths of a millimeter, of each supported paper size. The pOutput buffer receives an array of
/// POINT structures. Each structure contains the width (x-dimension) and length (y-dimension) of a paper size as if the paper
/// were in the DMORIENT_PORTRAIT orientation. The return value indicates the number of entries in the array.
/// </summary>
DC_PAPERSIZE = 3,
/// <summary>
/// Returns the minimum paper size that the dmPaperLength and dmPaperWidth members of the printer driver's DEVMODE structure can
/// specify. The LOWORD of the return value contains the minimum dmPaperWidth value, and the HIWORD contains the minimum
/// dmPaperLength value.
/// </summary>
DC_MINEXTENT = 4,
/// <summary>
/// Returns the maximum paper size that the dmPaperLength and dmPaperWidth members of the printer driver's DEVMODE structure can
/// specify. The LOWORD of the return value contains the maximum dmPaperWidth value, and the HIWORD contains the maximum
/// dmPaperLength value.
/// </summary>
DC_MAXEXTENT = 5,
/// <summary>
/// Retrieves a list of available paper bins. The pOutput buffer receives an array of WORD values that indicate the available
/// paper sources for the printer. The return value indicates the number of entries in the array. For a list of the possible
/// array values, see the description of the dmDefaultSource member of the DEVMODE structure. If pOutput is NULL, the return
/// value indicates the required number of entries in the array.
/// </summary>
DC_BINS = 6,
/// <summary>
/// If the printer supports duplex printing, the return value is 1; otherwise, the return value is zero. The pOutput parameter
/// is not used.
/// </summary>
DC_DUPLEX = 7,
/// <summary>Returns the dmSize member of the printer driver's DEVMODE structure.</summary>
DC_SIZE = 8,
/// <summary>
/// Returns the number of bytes required for the device-specific portion of the DEVMODE structure for the printer driver.
/// </summary>
DC_EXTRA = 9,
/// <summary>Returns the specification version to which the printer driver conforms.</summary>
DC_VERSION = 10,
/// <summary>Returns the version number of the printer driver.</summary>
DC_DRIVER = 11,
/// <summary>
/// Retrieves the names of the printer's paper bins. The pOutput buffer receives an array of string buffers. Each string buffer
/// is 24 characters long and contains the name of a paper bin. The return value indicates the number of entries in the array.
/// The name strings are null-terminated unless the name is 24 characters long. If pOutput is NULL, the return value is the
/// number of bin entries required.
/// </summary>
DC_BINNAMES = 12,
/// <summary>
/// Retrieves a list of the resolutions supported by the printer. The pOutput buffer receives an array of LONG values. For each
/// supported resolution, the array contains a pair of LONG values that specify the x and y dimensions of the resolution, in
/// dots per inch. The return value indicates the number of supported resolutions. If pOutput is NULL, the return value
/// indicates the number of supported resolutions.
/// </summary>
DC_ENUMRESOLUTIONS = 13,
/// <summary>
/// Retrieves the names of any additional files that need to be loaded when a driver is installed. The pOutput buffer receives
/// an array of string buffers. Each string buffer is 64 characters long and contains the name of a file. The return value
/// indicates the number of entries in the array. The name strings are null-terminated unless the name is 64 characters long. If
/// pOutput is NULL, the return value is the number of files.
/// </summary>
DC_FILEDEPENDENCIES = 14,
/// <summary>
/// Retrieves the abilities of the driver to use TrueType fonts. For DC_TRUETYPE, the pOutput parameter should be NULL. The
/// return value can be one or more of the following: DCTT_BITMAP Device can print TrueType fonts as graphics. DCTT_DOWNLOAD
/// Device can download TrueType fonts. DCTT_SUBDEV Device can substitute device fonts for TrueType fonts.
/// </summary>
DC_TRUETYPE = 15,
/// <summary>
/// Retrieves a list of supported paper names (for example, Letter or Legal). The pOutput buffer receives an array of string
/// buffers. Each string buffer is 64 characters long and contains the name of a paper form. The return value indicates the
/// number of entries in the array. The name strings are null-terminated unless the name is 64 characters long. If pOutput is
/// NULL, the return value is the number of paper forms.
/// </summary>
DC_PAPERNAMES = 16,
/// <summary>
/// Returns the relationship between portrait and landscape orientations for a device, in terms of the number of degrees that
/// portrait orientation is rotated counterclockwise to produce landscape orientation. The return value can be one of the
/// following: 0 No landscape orientation. 90 Portrait is rotated 90 degrees to produce landscape. 270 Portrait is rotated 270
/// degrees to produce landscape.
/// </summary>
DC_ORIENTATION = 17,
/// <summary>Returns the number of copies the device can print.</summary>
DC_COPIES = 18,
/// <summary>Not used for NT-based operating systems.</summary>
DC_BINADJUST = 19,
/// <summary>Not used for NT-based operating systems.</summary>
DC_EMF_COMPLIANT = 20,
/// <summary>Not used for NT-based operating systems.</summary>
DC_DATATYPE_PRODUCED = 21,
/// <summary>
/// If the printer supports collating, the return value is 1; otherwise, the return value is zero. The pOutput parameter is not used.
/// </summary>
DC_COLLATE = 22,
/// <summary>Not used for NT-based operating systems.</summary>
DC_MANUFACTURER = 23,
/// <summary>Not used for NT-based operating systems.</summary>
DC_MODEL = 24,
/// <summary>
/// Retrieves a list of printer description languages supported by the printer. The pOutput buffer receives an array of string
/// buffers. Each buffer is 32 characters long and contains the name of a printer description language. The return value
/// indicates the number of entries in the array. The name strings are null-terminated unless the name is 32 characters long. If
/// pOutput is NULL, the return value indicates the required number of array entries.
/// </summary>
DC_PERSONALITY = 25,
/// <summary>
/// The return value indicates the printer's print rate. The value returned for DC_PRINTRATEUNIT indicates the units of the
/// DC_PRINTRATE value. The pOutput parameter is not used.
/// </summary>
DC_PRINTRATE = 26,
/// <summary>
/// The return value is one of the following values that indicate the print rate units for the value returned for the
/// DC_PRINTRATE flag. The pOutput parameter is not used. PRINTRATEUNIT_CPS Characters per second. PRINTRATEUNIT_IPM Inches per
/// minute. PRINTRATEUNIT_LPM Lines per minute. PRINTRATEUNIT_PPM Pages per minute.
/// </summary>
DC_PRINTRATEUNIT = 27,
/// <summary>The return value is the amount of available printer memory, in kilobytes. The pOutput parameter is not used.</summary>
DC_PRINTERMEM = 28,
/// <summary>
/// Retrieves the names of the paper forms that are currently available for use. The pOutput buffer receives an array of string
/// buffers. Each string buffer is 64 characters long and contains the name of a paper form. The return value indicates the
/// number of entries in the array. The name strings are null-terminated unless the name is 64 characters long. If pOutput is
/// NULL, the return value is the number of paper forms.
/// </summary>
DC_MEDIAREADY = 29,
/// <summary>
/// If the printer supports stapling, the return value is a nonzero value; otherwise, the return value is zero. The pOutput
/// parameter is not used.
/// </summary>
DC_STAPLE = 30,
/// <summary>The return value indicates the printer's print rate, in pages per minute. The pOutput parameter is not used.</summary>
DC_PRINTRATEPPM = 31,
/// <summary>
/// If the printer supports color printing, the return value is 1; otherwise, the return value is zero. The pOutput parameter is
/// not used.
/// </summary>
DC_COLORDEVICE = 32,
/// <summary>
/// Retrieves an array of integers that indicate that printer's ability to print multiple document pages per printed page. The
/// pOutput buffer receives an array of DWORD values. Each value represents a supported number of document pages per printed
/// page. The return value indicates the number of entries in the array. If pOutput is NULL, the return value indicates the
/// required number of entries in the array.
/// </summary>
DC_NUP = 33,
/// <summary>
/// Retrieves the names of the supported media types. The pOutput buffer receives an array of string buffers. Each string buffer
/// is 64 characters long and contains the name of a supported media type. The return value indicates the number of entries in
/// the array. The strings are null-terminated unless the name is 64 characters long. If pOutput is NULL, the return value is
/// the number of media type names required.
/// </summary>
DC_MEDIATYPENAMES = 34,
/// <summary>
/// Retrieves a list of supported media types. The pOutput buffer receives an array of DWORD values that indicate the supported
/// media types. The return value indicates the number of entries in the array. For a list of possible array values, see the
/// description of the dmMediaType member of the DEVMODE structure. If pOutput is NULL, the return value indicates the required
/// number of entries in the array.
/// </summary>
DC_MEDIATYPES = 35,
}
/// <summary>Device mode flags.</summary>

296
PInvoke/Printing/WinSpool.Funcs.cs
View File

@ -835,6 +835,302 @@ namespace Vanara.PInvoke
[PInvokeData("winspool.h", MSDNShortId = "0bd81b43-5c1e-4989-8350-2ec0dc215f28")]
public static extern Win32Error DeletePrinterKey(HPRINTER hPrinter, string pKeyName);
/// <summary>The <c>DeviceCapabilities</c> function retrieves the capabilities of a printer driver.</summary>
/// <param name="pDevice">
/// A pointer to a null-terminated string that contains the name of the printer. Note that this is the name of the printer, not of
/// the printer driver.
/// </param>
/// <param name="pPort">
/// A pointer to a null-terminated string that contains the name of the port to which the device is connected, such as LPT1.
/// </param>
/// <param name="fwCapability">
/// <para>The capabilities to be queried. This parameter can be one of the following values.</para>
/// <list type="table">
/// <listheader>
/// <term>Value</term>
/// <term>Meaning</term>
/// </listheader>
/// <item>
/// <term>DC_BINNAMES</term>
/// <term>
/// Retrieves the names of the printer's paper bins. The pOutput buffer receives an array of string buffers. Each string buffer is
/// 24 characters long and contains the name of a paper bin. The return value indicates the number of entries in the array. The name
/// strings are null-terminated unless the name is 24 characters long. If pOutput is NULL, the return value is the number of bin
/// entries required.
/// </term>
/// </item>
/// <item>
/// <term>DC_BINS</term>
/// <term>
/// Retrieves a list of available paper bins. The pOutput buffer receives an array of WORD values that indicate the available paper
/// sources for the printer. The return value indicates the number of entries in the array. For a list of the possible array values,
/// see the description of the dmDefaultSource member of the DEVMODE structure. If pOutput is NULL, the return value indicates the
/// required number of entries in the array.
/// </term>
/// </item>
/// <item>
/// <term>DC_COLLATE</term>
/// <term>
/// If the printer supports collating, the return value is 1; otherwise, the return value is zero. The pOutput parameter is not used.
/// </term>
/// </item>
/// <item>
/// <term>DC_COLORDEVICE</term>
/// <term>
/// If the printer supports color printing, the return value is 1; otherwise, the return value is zero. The pOutput parameter is not used.
/// </term>
/// </item>
/// <item>
/// <term>DC_COPIES</term>
/// <term>Returns the number of copies the device can print.</term>
/// </item>
/// <item>
/// <term>DC_DRIVER</term>
/// <term>Returns the version number of the printer driver.</term>
/// </item>
/// <item>
/// <term>DC_DUPLEX</term>
/// <term>
/// If the printer supports duplex printing, the return value is 1; otherwise, the return value is zero. The pOutput parameter is
/// not used.
/// </term>
/// </item>
/// <item>
/// <term>DC_ENUMRESOLUTIONS</term>
/// <term>
/// Retrieves a list of the resolutions supported by the printer. The pOutput buffer receives an array of LONG values. For each
/// supported resolution, the array contains a pair of LONG values that specify the x and y dimensions of the resolution, in dots
/// per inch. The return value indicates the number of supported resolutions. If pOutput is NULL, the return value indicates the
/// number of supported resolutions.
/// </term>
/// </item>
/// <item>
/// <term>DC_EXTRA</term>
/// <term>Returns the number of bytes required for the device-specific portion of the DEVMODE structure for the printer driver.</term>
/// </item>
/// <item>
/// <term>DC_FIELDS</term>
/// <term>
/// Returns the dmFields member of the printer driver's DEVMODE structure. The dmFields member indicates which members in the
/// device-independent portion of the structure are supported by the printer driver.
/// </term>
/// </item>
/// <item>
/// <term>DC_FILEDEPENDENCIES</term>
/// <term>
/// Retrieves the names of any additional files that need to be loaded when a driver is installed. The pOutput buffer receives an
/// array of string buffers. Each string buffer is 64 characters long and contains the name of a file. The return value indicates
/// the number of entries in the array. The name strings are null-terminated unless the name is 64 characters long. If pOutput is
/// NULL, the return value is the number of files.
/// </term>
/// </item>
/// <item>
/// <term>DC_MAXEXTENT</term>
/// <term>
/// Returns the maximum paper size that the dmPaperLength and dmPaperWidth members of the printer driver's DEVMODE structure can
/// specify. The LOWORD of the return value contains the maximum dmPaperWidth value, and the HIWORD contains the maximum
/// dmPaperLength value.
/// </term>
/// </item>
/// <item>
/// <term>DC_MEDIAREADY</term>
/// <term>
/// Retrieves the names of the paper forms that are currently available for use. The pOutput buffer receives an array of string
/// buffers. Each string buffer is 64 characters long and contains the name of a paper form. The return value indicates the number
/// of entries in the array. The name strings are null-terminated unless the name is 64 characters long. If pOutput is NULL, the
/// return value is the number of paper forms.
/// </term>
/// </item>
/// <item>
/// <term>DC_MEDIATYPENAMES</term>
/// <term>
/// Retrieves the names of the supported media types. The pOutput buffer receives an array of string buffers. Each string buffer is
/// 64 characters long and contains the name of a supported media type. The return value indicates the number of entries in the
/// array. The strings are null-terminated unless the name is 64 characters long. If pOutput is NULL, the return value is the number
/// of media type names required.
/// </term>
/// </item>
/// <item>
/// <term>DC_MEDIATYPES</term>
/// <term>
/// Retrieves a list of supported media types. The pOutput buffer receives an array of DWORD values that indicate the supported
/// media types. The return value indicates the number of entries in the array. For a list of possible array values, see the
/// description of the dmMediaType member of the DEVMODE structure. If pOutput is NULL, the return value indicates the required
/// number of entries in the array.
/// </term>
/// </item>
/// <item>
/// <term>DC_MINEXTENT</term>
/// <term>
/// Returns the minimum paper size that the dmPaperLength and dmPaperWidth members of the printer driver's DEVMODE structure can
/// specify. The LOWORD of the return value contains the minimum dmPaperWidth value, and the HIWORD contains the minimum
/// dmPaperLength value.
/// </term>
/// </item>
/// <item>
/// <term>DC_ORIENTATION</term>
/// <term>
/// Returns the relationship between portrait and landscape orientations for a device, in terms of the number of degrees that
/// portrait orientation is rotated counterclockwise to produce landscape orientation. The return value can be one of the following:
/// 0 No landscape orientation. 90 Portrait is rotated 90 degrees to produce landscape. 270 Portrait is rotated 270 degrees to
/// produce landscape.
/// </term>
/// </item>
/// <item>
/// <term>DC_NUP</term>
/// <term>
/// Retrieves an array of integers that indicate that printer's ability to print multiple document pages per printed page. The
/// pOutput buffer receives an array of DWORD values. Each value represents a supported number of document pages per printed page.
/// The return value indicates the number of entries in the array. If pOutput is NULL, the return value indicates the required
/// number of entries in the array.
/// </term>
/// </item>
/// <item>
/// <term>DC_PAPERNAMES</term>
/// <term>
/// Retrieves a list of supported paper names (for example, Letter or Legal). The pOutput buffer receives an array of string
/// buffers. Each string buffer is 64 characters long and contains the name of a paper form. The return value indicates the number
/// of entries in the array. The name strings are null-terminated unless the name is 64 characters long. If pOutput is NULL, the
/// return value is the number of paper forms.
/// </term>
/// </item>
/// <item>
/// <term>DC_PAPERS</term>
/// <term>
/// Retrieves a list of supported paper sizes. The pOutput buffer receives an array of WORD values that indicate the available paper
/// sizes for the printer. The return value indicates the number of entries in the array. For a list of the possible array values,
/// see the description of the dmPaperSize member of the DEVMODE structure. If pOutput is NULL, the return value indicates the
/// required number of entries in the array.
/// </term>
/// </item>
/// <item>
/// <term>DC_PAPERSIZE</term>
/// <term>
/// Retrieves the dimensions, in tenths of a millimeter, of each supported paper size. The pOutput buffer receives an array of POINT
/// structures. Each structure contains the width (x-dimension) and length (y-dimension) of a paper size as if the paper were in the
/// DMORIENT_PORTRAIT orientation. The return value indicates the number of entries in the array.
/// </term>
/// </item>
/// <item>
/// <term>DC_PERSONALITY</term>
/// <term>
/// Retrieves a list of printer description languages supported by the printer. The pOutput buffer receives an array of string
/// buffers. Each buffer is 32 characters long and contains the name of a printer description language. The return value indicates
/// the number of entries in the array. The name strings are null-terminated unless the name is 32 characters long. If pOutput is
/// NULL, the return value indicates the required number of array entries.
/// </term>
/// </item>
/// <item>
/// <term>DC_PRINTERMEM</term>
/// <term>The return value is the amount of available printer memory, in kilobytes. The pOutput parameter is not used.</term>
/// </item>
/// <item>
/// <term>DC_PRINTRATE</term>
/// <term>
/// The return value indicates the printer's print rate. The value returned for DC_PRINTRATEUNIT indicates the units of the
/// DC_PRINTRATE value. The pOutput parameter is not used.
/// </term>
/// </item>
/// <item>
/// <term>DC_PRINTRATEPPM</term>
/// <term>The return value indicates the printer's print rate, in pages per minute. The pOutput parameter is not used.</term>
/// </item>
/// <item>
/// <term>DC_PRINTRATEUNIT</term>
/// <term>
/// The return value is one of the following values that indicate the print rate units for the value returned for the DC_PRINTRATE
/// flag. The pOutput parameter is not used. PRINTRATEUNIT_CPS Characters per second. PRINTRATEUNIT_IPM Inches per minute.
/// PRINTRATEUNIT_LPM Lines per minute. PRINTRATEUNIT_PPM Pages per minute.
/// </term>
/// </item>
/// <item>
/// <term>DC_SIZE</term>
/// <term>Returns the dmSize member of the printer driver's DEVMODE structure.</term>
/// </item>
/// <item>
/// <term>DC_STAPLE</term>
/// <term>
/// If the printer supports stapling, the return value is a nonzero value; otherwise, the return value is zero. The pOutput
/// parameter is not used.
/// </term>
/// </item>
/// <item>
/// <term>DC_TRUETYPE</term>
/// <term>
/// Retrieves the abilities of the driver to use TrueType fonts. For DC_TRUETYPE, the pOutput parameter should be NULL. The return
/// value can be one or more of the following: DCTT_BITMAP Device can print TrueType fonts as graphics. DCTT_DOWNLOAD Device can
/// download TrueType fonts. DCTT_SUBDEV Device can substitute device fonts for TrueType fonts.
/// </term>
/// </item>
/// <item>
/// <term>DC_VERSION</term>
/// <term>Returns the specification version to which the printer driver conforms.</term>
/// </item>
/// </list>
/// </param>
/// <param name="pOutput">
/// A pointer to an array. The format of the array depends on the setting of the fwCapability parameter. See each capability above
/// to find out what is returned if pOutput is <c>NULL</c>.
/// </param>
/// <param name="pDevMode">
/// A pointer to a DEVMODE structure. If this parameter is <c>NULL</c>, <c>DeviceCapabilities</c> retrieves the current default
/// initialization values for the specified printer driver. Otherwise, the function retrieves the values contained in the structure
/// to which pDevMode points.
/// </param>
/// <returns>
/// <para>
/// If the function succeeds, the return value depends on the setting of the fwCapability parameter. A return value of zero
/// generally indicates that, while the function completed successfully, there was some type of failure, such as a capability that
/// is not supported. For more details, see the descriptions for the fwCapability values.
/// </para>
/// <para>
/// If the function returns -1, this may mean either that the capability is not supported or there was a general function failure.
/// </para>
/// </returns>
/// <remarks>
/// <para>
/// <c>Note</c> This is a blocking or synchronous function and might not return immediately. How quickly this function returns
/// depends on run-time factors such as network status, print server configuration, and printer driver implementation—factors that
/// are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user
/// interface could make the application appear to be unresponsive.
/// </para>
/// <para>The DEVMODE structure pointed to by the pDevMode parameter may be obtained by calling the DocumentProperties function.</para>
/// <para>
/// If a printer driver supports custom device capabilities, the driver must call the SetPrinterData function for each custom
/// capability. The <c>SetPrinterData</c> function adds the appropriate printer data to the print system, which enables 32-bit
/// applications to access the custom capabilities on 64-bit Windows installations.
/// </para>
/// <para>
/// For each custom capability, you must first add printer data that describes the type of the capability. To do this, when you call
/// <c>SetPrinterData</c>, set the pValueName string to <c>CustomDeviceCapabilityType_Xxx</c>, where "Xxx" is the hexadecimal
/// representation of the capability. For example, you might have "CustomDeviceCapabilityType_1234". The registry data that you set
/// must be of the <c>REG_DWORD</c> type, and you must set its value to one of the following:
/// </para>
/// <list type="bullet">
/// <item>
/// <term>0, if the custom capability is a <c>DWORD</c></term>
/// </item>
/// <item>
/// <term>1, if the custom capability is a buffer of bytes</term>
/// </item>
/// <item>
/// <term>2, if the custom capability is an array of items</term>
/// </item>
/// </list>
/// <para>
/// If the custom capability is an array of items, you must call <c>SetPinterData</c> a second time to provide information about the
/// size of an item in the array. To do this, when you call <c>SetPinterData</c>, the pValueName string that you provide must be
/// "CustomDeviceCapabilitySize_Xxx" where Xxx is the hexadecimal representation of the capability. For example, you might have
/// "CustomDeviceCapabilitySize_1234". The registry data that you set must be of the <c>REG_DWORD</c> type, and you must set its
/// value to the size in bytes of an item in the array.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/win32/api/wingdi/nf-wingdi-devicecapabilitiesa
// int DeviceCapabilitiesA( LPCSTR pDevice, LPCSTR pPort, WORD fwCapability, LPSTR pOutput, const DEVMODEA *pDevMode );
[DllImport(Lib.Winspool, SetLastError = false, CharSet = CharSet.Auto)]
[PInvokeData("wingdi.h", MSDNShortId = "d7f63ef7-0a2e-47c3-9e81-6e8a6dffe9af")]
public static extern int DeviceCapabilities(string pDevice, [Optional] string pPort, DC fwCapability, IntPtr pOutput, in DEVMODE pDevMode);
/// <summary>The <c>DocumentEvent</c> function is an event handler for events associated with printing a document.</summary>
/// <param name="hPrinter">
/// A handle to a printer object. Use the <c>OpenPrinter</c> or <c>AddPrinter</c> function to retrieve a printer handle.

173
PInvoke/Printing/WinSpool.Structs.cs
View File

@ -155,57 +155,6 @@ namespace Vanara.PInvoke
public uint dwFlags;
}
/// <summary>
/// The <c>DOCINFO</c> structure contains the input and output file names and other information used by the StartDoc function.
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-docinfoa typedef struct _DOCINFOA { int cbSize; LPCSTR
// lpszDocName; LPCSTR lpszOutput; LPCSTR lpszDatatype; DWORD fwType; } DOCINFOA, *LPDOCINFOA;
[PInvokeData("wingdi.h", MSDNShortId = "329bf0d9-399b-4f64-a029-361ef7558aeb")]
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Auto)]
public struct DOCINFO
{
/// <summary>The size, in bytes, of the structure.</summary>
public int cbSize;
/// <summary>Pointer to a null-terminated string that specifies the name of the document.</summary>
[MarshalAs(UnmanagedType.LPTStr)]
public string lpszDocName;
/// <summary>
/// Pointer to a null-terminated string that specifies the name of an output file. If this pointer is <c>NULL</c>, the output
/// will be sent to the device identified by the device context handle that was passed to the StartDoc function.
/// </summary>
[MarshalAs(UnmanagedType.LPTStr)]
public string lpszOutput;
/// <summary>
/// Pointer to a null-terminated string that specifies the type of data used to record the print job. The legal values for this
/// member can be found by calling EnumPrintProcessorDatatypes and can include such values as raw, emf, or XPS_PASS. This member
/// can be <c>NULL</c>. Note that the requested data type might be ignored.
/// </summary>
[MarshalAs(UnmanagedType.LPTStr)]
public string lpszDatatype;
/// <summary>
/// <para>Specifies additional information about the print job. This member must be zero or one of the following values.</para>
/// <list type="table">
/// <listheader>
/// <term>Value</term>
/// <term>Meaning</term>
/// </listheader>
/// <item>
/// <term>DI_APPBANDING</term>
/// <term>Applications that use banding should set this flag for optimal performance during printing.</term>
/// </item>
/// <item>
/// <term>DI_ROPS_READ_DESTINATION</term>
/// <term>The application will use raster operations that involve reading from the destination surface.</term>
/// </item>
/// </list>
/// </summary>
public DI fwType;
}
/// <summary>The <c>DRIVER_INFO_1</c> structure identifies a printer driver.</summary>
// https://docs.microsoft.com/en-us/windows/win32/printdocs/driver-info-1 typedef struct _DRIVER_INFO_1 { LPTSTR pName; }
// DRIVER_INFO_1, *PDRIVER_INFO_1;
@ -1992,63 +1941,6 @@ namespace Vanara.PInvoke
public string pszDriverName;
}
/// <summary>
/// The <c>PRINTER_DEFAULTS</c> structure specifies the default data type, environment, initialization data, and access rights for a printer.
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/printdocs/printer-defaults typedef struct _PRINTER_DEFAULTS { LPTSTR pDatatype;
// LPDEVMODE pDevMode; ACCESS_MASK DesiredAccess; } PRINTER_DEFAULTS, *PPRINTER_DEFAULTS;
[PInvokeData("winspool.h", MSDNShortId = "df29c3a6-b1d1-4d40-887d-5ffc032a5871")]
public class PRINTER_DEFAULTS
{
/// <summary>Pointer to a null-terminated string that specifies the default data type for a printer.</summary>
public string pDatatype;
/// <summary>
/// A <c>DEVMODE</c> structure that identifies the default environment and initialization data for a printer.
/// </summary>
public DEVMODE? pDevMode;
/// <summary>
/// <para>
/// Specifies desired access rights for a printer. The <c>OpenPrinter</c> function uses this member to set access rights to the
/// printer. These rights can affect the operation of the <c>SetPrinter</c> and <c>DeletePrinter</c> functions. The access
/// rights can be one of the following.
/// </para>
/// <list type="table">
/// <listheader>
/// <term>Value</term>
/// <term>Meaning</term>
/// </listheader>
/// <item>
/// <term>PRINTER_ACCESS_ADMINISTER</term>
/// <term>To perform administrative tasks, such as those provided by SetPrinter.</term>
/// </item>
/// <item>
/// <term>PRINTER_ACCESS_USE</term>
/// <term>To perform basic printing operations.</term>
/// </item>
/// <item>
/// <term>PRINTER_ACCESS_MANAGE_LIMITED</term>
/// <term>
/// To perform administrative tasks, such as those provided by SetPrinter and SetPrinterData. This value is available starting
/// from Windows 8.1.
/// </term>
/// </item>
/// <item>
/// <term>PRINTER_ALL_ACCESS</term>
/// <term>
/// To perform all administrative tasks and basic printing operations except for SYNCHRONIZE (see Standard Access Rights ).
/// </term>
/// </item>
/// <item>
/// <term>generic security values, such as WRITE_DAC</term>
/// <term>To allow specific control access rights. See Standard Access Rights.</term>
/// </item>
/// </list>
/// </summary>
public ACCESS_MASK DesiredAccess;
}
/// <summary>
/// The <c>PRINTER_ENUM_VALUES</c> structure specifies the value name, type, and data for a printer configuration value returned by
/// the <c>EnumPrinterDataEx</c> function.
@ -3677,6 +3569,61 @@ namespace Vanara.PInvoke
public string pOrder;
}
/// <summary>
/// The <c>PRINTER_DEFAULTS</c> structure specifies the default data type, environment, initialization data, and access rights for a printer.
/// </summary>
// https://docs.microsoft.com/en-us/windows/win32/printdocs/printer-defaults typedef struct _PRINTER_DEFAULTS { LPTSTR pDatatype;
// LPDEVMODE pDevMode; ACCESS_MASK DesiredAccess; } PRINTER_DEFAULTS, *PPRINTER_DEFAULTS;
[PInvokeData("winspool.h", MSDNShortId = "df29c3a6-b1d1-4d40-887d-5ffc032a5871")]
public class PRINTER_DEFAULTS
{
/// <summary>
/// <para>
/// Specifies desired access rights for a printer. The <c>OpenPrinter</c> function uses this member to set access rights to the
/// printer. These rights can affect the operation of the <c>SetPrinter</c> and <c>DeletePrinter</c> functions. The access
/// rights can be one of the following.
/// </para>
/// <list type="table">
/// <listheader>
/// <term>Value</term>
/// <term>Meaning</term>
/// </listheader>
/// <item>
/// <term>PRINTER_ACCESS_ADMINISTER</term>
/// <term>To perform administrative tasks, such as those provided by SetPrinter.</term>
/// </item>
/// <item>
/// <term>PRINTER_ACCESS_USE</term>
/// <term>To perform basic printing operations.</term>
/// </item>
/// <item>
/// <term>PRINTER_ACCESS_MANAGE_LIMITED</term>
/// <term>
/// To perform administrative tasks, such as those provided by SetPrinter and SetPrinterData. This value is available starting
/// from Windows 8.1.
/// </term>
/// </item>
/// <item>
/// <term>PRINTER_ALL_ACCESS</term>
/// <term>
/// To perform all administrative tasks and basic printing operations except for SYNCHRONIZE (see Standard Access Rights ).
/// </term>
/// </item>
/// <item>
/// <term>generic security values, such as WRITE_DAC</term>
/// <term>To allow specific control access rights. See Standard Access Rights.</term>
/// </item>
/// </list>
/// </summary>
public ACCESS_MASK DesiredAccess;
/// <summary>Pointer to a null-terminated string that specifies the default data type for a printer.</summary>
public string pDatatype;
/// <summary>A <c>DEVMODE</c> structure that identifies the default environment and initialization data for a printer.</summary>
public DEVMODE? pDevMode;
}
/// <summary>Provides a <see cref="SafeHandle"/> for <see cref="HPRINTER"/> that is disposed using <see cref="ClosePrinter"/>.</summary>
public class SafeHPRINTER : SafeHANDLE
{
@ -3739,16 +3686,16 @@ namespace Vanara.PInvoke
/// <summary>Initializes a new instance of the <see cref="SafeHSPOOLFILE"/> class.</summary>
private SafeHSPOOLFILE() : base() { }
/// <summary>Performs an implicit conversion from <see cref="SafeHSPOOLFILE"/> to <see cref="HSPOOLFILE"/>.</summary>
/// <param name="h">The safe handle instance.</param>
/// <returns>The result of the conversion.</returns>
public static implicit operator HSPOOLFILE(SafeHSPOOLFILE h) => h.handle;
/// <summary>Performs an implicit conversion from <see cref="SafeHSPOOLFILE"/> to <see cref="HFILE"/>.</summary>
/// <param name="h">The safe handle instance.</param>
/// <returns>The result of the conversion.</returns>
public static implicit operator HFILE(SafeHSPOOLFILE h) => h.handle;
/// <summary>Performs an implicit conversion from <see cref="SafeHSPOOLFILE"/> to <see cref="HSPOOLFILE"/>.</summary>
/// <param name="h">The safe handle instance.</param>
/// <returns>The result of the conversion.</returns>
public static implicit operator HSPOOLFILE(SafeHSPOOLFILE h) => h.handle;
/// <inheritdoc/>
protected override bool InternalReleaseHandle() => CloseSpoolFileHandle(hPrinter, handle);
}