PrtDevIOCtl: Difference between revisions

Latest revision as of 20:33, 30 May 2021

PrtDevIOCtl passes device-specific commands to the device. PrtDevIOCtl is an emulation of DosDevIOCtl.

Note: Under OS/2, PM port drivers are responsible for initializing printer ports; presentation drivers should not need to use this function.

Syntax

PrtDevIOCtl(pData, pParms, ulFunction, ulCategory, hDevice)

Parameters

pData (PVOID) - input: A pointer to a data packet.
pParms (PVOID) - input: The parameter list.
ulFunction (ULONG) - input: The function number.
ulCategory (ULONG) - input: The category code.
hDevice (HFILE) - input: The device handle returned by PrtOpen.

Return Code

rc (ULONG) - returns: Return codes.

This function returns the same codes as DosDevIOCtl:

ERROR_BAD_DRIVER_LEVEL
ERROR_GEN_FAILURE
ERROR_INVALID_CATEGORY
ERROR_INVALID_DRIVE
ERROR_INVALID_FUNCTION
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_MONITORS_NOT_SUPPORTED
ERROR_PROTECTION_VIOLATION
ERROR_UNCERTAIN_MEDIA
NO_ERROR

Remarks

For a full description of the parameters, see the function "DosDevIOCtl" in the Presentation Manager Programming Reference. For further information about the IOCtl interface, see the chapter on generic IOCtl commands in the OS/2 Physical Device Driver Reference.

@@ Line 1: / Line 1: @@
-PrtDevIOCtl passes device-specific commands to the device. PrtDevIOCtl is an emulation of DosDevIOCtl.
+PrtDevIOCtl passes device-specific commands to the device. PrtDevIOCtl is an emulation of [[DosDevIOCtl]].
-; Note: Under OS/2, PM port drivers are responsible for initializing printer ports; presentation drivers should not need to use this function.
+;Note: Under OS/2, PM port drivers are responsible for initializing printer ports; presentation drivers should not need to use this function.
 ==Syntax==
-  PrtDevIOCtl(pData, pParms, ulFunction, ulCategory, hDevice);
+  PrtDevIOCtl(pData, pParms, ulFunction, ulCategory, hDevice)
 ==Parameters==
-; pData (PVOID) - input
+;pData (PVOID) - input: A pointer to a data packet.
-: A pointer to a data packet.
+;pParms (PVOID) - input: The parameter list.
+;ulFunction (ULONG) - input: The function number.
-; pParms (PVOID) - input
+;ulCategory (ULONG) - input: The category code.
-: The parameter list.
+;hDevice (HFILE) - input: The device handle returned by [[PrtOpen]].
-; ulFunction (ULONG) - input
-: The function number.
-; ulCategory (ULONG) - input
-: The category code.
-; hDevice (HFILE) - input
-: The device handle returned by PrtOpen.
 ==Return Code==
-; rc (ULONG) - returns
+;rc (ULONG) - returns: Return codes.
-: Return codes.
+This function returns the same codes as DosDevIOCtl:
+* ERROR_BAD_DRIVER_LEVEL
-This function returns the same codes as DosDevIOCtl:
+* ERROR_GEN_FAILURE
-* ERROR_BAD_DRIVER_LEVEL
+* ERROR_INVALID_CATEGORY
-* ERROR_GEN_FAILURE
+* ERROR_INVALID_DRIVE
-* ERROR_INVALID_CATEGORY
+* ERROR_INVALID_FUNCTION
-* ERROR_INVALID_DRIVE
+* ERROR_INVALID_HANDLE
-* ERROR_INVALID_FUNCTION
+* ERROR_INVALID_PARAMETER
-* ERROR_INVALID_HANDLE
+* ERROR_MONITORS_NOT_SUPPORTED
-* ERROR_INVALID_PARAMETER
+* ERROR_PROTECTION_VIOLATION
-* ERROR_MONITORS_NOT_SUPPORTED
+* ERROR_UNCERTAIN_MEDIA
-* ERROR_PROTECTION_VIOLATION
+* NO_ERROR
-* ERROR_UNCERTAIN_MEDIA
-* NO_ERROR
 ==Remarks==
 For a full description of the parameters, see the function "DosDevIOCtl" in the Presentation Manager Programming Reference. For further information about the IOCtl interface, see the chapter on generic IOCtl commands in the OS/2 Physical Device Driver Reference.
-==Example Code==
-<PRE>
-#include <os2.h>
-PVOID    pData;       /*  A pointer to a data packet. */
-PVOID    pParms;      /*  The parameter list. */
-ULONG    ulFunction;  /*  The function number. */
-ULONG    ulCategory;  /*  The category code. */
-HFILE    hDevice;     /*  The device handle returned by PrtOpen. */
-ULONG    rc;          /*  Return codes. */
-rc = PrtDevIOCtl(pData, pParms, ulFunction,
-       ulCategory, hDevice);
-</PRE>
 [[Category:Prt]]