win32-def/src/lib/struct/winspool/PRINTER_DEFAULTS.ts

win32 definitions for node-ffi

import * as D from '##/lib/common.def.js'
import type * as T from '##/lib/common.types.js'
import type { StructFactoryResult, StructInitType } from '##/lib/types.js'

import { genStruct } from '../struct.helper.js'
import { DEVMODEW_Factory } from '../wingdi/DEVMODEW.js'
import type { DEVMODEW_Type } from '../wingdi/DEVMODEW.js'


const key = 'PRINTER_DEFAULTS'
const ptr = `${key}*` as const
const init: StructInitType = {
  pDatatype: D.LPTSTR,
  pDevMode: DEVMODEW_Factory,
  DesiredAccess: D.ACCESS_MASK,
} as const

export const PPRINTER_DEFAULTS = ptr
export const PRINTER_DEFAULTS_Name = key
export const PRINTER_DEFAULTS_Init: typeof init = init

/**
 * PRINTER_DEFAULTS structure,
 * Specifies the default data type, environment, initialization data, and access rights for a printer.
 * @link https://learn.microsoft.com/en-us/windows/win32/printdocs/printer-defaults
 */
export function PRINTER_DEFAULTS_Factory(): StructFactoryResult<PRINTER_DEFAULTS_Type> {
  return genStruct<PRINTER_DEFAULTS_Type>(init, key, ptr)
}

/**
 * PRINTER_DEFAULTS structure,
 * Specifies the default data type, environment, initialization data, and access rights for a printer.
 * @link https://learn.microsoft.com/en-us/windows/win32/printdocs/printer-defaults
 */
export interface PRINTER_DEFAULTS_Type {
  /**
   * Pointer to a null-terminated string that specifies the default data type for a printer.
   */
  pDatatype: T.LPTSTR
  /**
   * Pointer to a DEVMODE structure that identifies the default environment and initialization data for a printer.
   */
  pDevMode: DEVMODEW_Type
  DesiredAccess: T.ACCESS_MASK
}