nt4/PortEnum.c File Reference

Functions for communicating with the parallel port driver. More...

#include <initguid.h>
#include <ntddk.h>
#include "cbm_driver.h"

Go to the source code of this file.

Defines
#define	PENUMERATE_DEFINED
	Make sure the PENUMERATE is correctly defined.
Typedefs
typedef ENUMERATE_NT4 *	PENUMERATE
typedef ENUMERATE_NT4	ENUMERATE
Functions
NTSTATUS	ParPortEnumerateOpen (PENUMERATE *EnumStruct)
	Start enumeration of the parallel port drivers.
NTSTATUS	ParPortEnumerate (PENUMERATE EnumStruct, PCWSTR *DriverName)
	Get next enumerated parallel port driver.
VOID	ParPortEnumerateClose (PENUMERATE EnumStruct)
	Stop enumeration of the parallel port drivers.
NTSTATUS	CbmOpenDeviceRegistryKey (IN PDEVICE_OBJECT a, IN ULONG b, IN ACCESS_MASK c, OUT PHANDLE d)
	Stub for a function.

---

Detailed Description

Functions for communicating with the parallel port driver.

**************************************************************

Author:

Spiro Trikaliotis

Version:

Id

PortEnum.c,v 1.19 2006/02/24 12:01:26 trikalio Exp

Definition in file nt4/PortEnum.c.

---

Typedef Documentation

typedef struct ENUMERATE_NT4 ENUMERATE

This struct is used as internal storage for the ParPortEnumerateOpen()/ParPortEnumerate()/ParPortEnumerateClose() functions

typedef struct ENUMERATE_NT4 * PENUMERATE

This struct is used as internal storage for the ParPortEnumerateOpen()/ParPortEnumerate()/ParPortEnumerateClose() functions Definition at line 24 of file nt4/PortEnum.c.

---

Function Documentation

NTSTATUS CbmOpenDeviceRegistryKey (  IN PDEVICE_OBJECT  a, IN ULONG  b, IN ACCESS_MASK  c, OUT PHANDLE  d )

Stub for a function. This function is not available on NT4, and it is not needed. Because of this, we define it here for cbm4nt.sys, so that the driver successfully loads Definition at line 304 of file nt4/PortEnum.c. References DBG_ASSERT, and FUNC_ENTER.

NTSTATUS ParPortEnumerate (  PENUMERATE  EnumStruct, PCWSTR *  DriverName )

Get next enumerated parallel port driver. This function starts the enumeration process of the parallel port drivers Parameters: EnumStruct  Pointer to a ENUMERATE structure. This is internal storage for these functions. DriverName;  Pointer to a storage area which will contain the next driver implementing this interface. Returns: If the routine succeeds, it returns STATUS_SUCCESS. Otherwise, it returns one of the error status values. For enumerating, a caller has to do the following: Allocate memory for an ENUMERATE structure Call ParPortEnumerateOpen() with the allocated memory Call ParPortEnumerate() in a loop to get each next parallel port, until an error code shows that there is no more parallel port. Close the enumeration process by ParPortEnumerateClose() Definition at line 197 of file nt4/PortEnum.c. References DBG_ASSERT, and FUNC_ENTER.

VOID ParPortEnumerateClose (  PENUMERATE  EnumStruct  )

Stop enumeration of the parallel port drivers. This function stops the enumeration process of the parallel port drivers Parameters: EnumStruct  Pointer to a ENUMERATE structure, which contains the last enumerated driver For enumerating, a caller has to do the following: Allocate memory for an ENUMERATE structure Call ParPortEnumerateOpen() with the allocated memory Call ParPortEnumerate() in a loop to get each next parallel port, until an error code shows that there is no more parallel port. Close the enumeration process by ParPortEnumerateClose() Definition at line 265 of file nt4/PortEnum.c. References DBG_ASSERT, FUNC_ENTER, and FUNC_LEAVE.

NTSTATUS ParPortEnumerateOpen (  PENUMERATE *  EnumStruct  )

Start enumeration of the parallel port drivers. This function starts the enumeration process of the parallel port drivers Parameters: EnumStruct  Pointer to a pointer to hold an ENUMERATE structure. This is internal storage for these functions, and it is allocated by this function. Returns: If the routine succeeds, it returns STATUS_SUCCESS. Otherwise, it returns one of the error status values. For enumerating, a caller has to do the following: Allocate memory for an ENUMERATE structure Call ParPortEnumerateOpen() with the allocated memory Call ParPortEnumerate() in a loop to get each next parallel port, until an error code shows that there is no more parallel port. Close the enumeration process by ParPortEnumerateClose() Definition at line 75 of file nt4/PortEnum.c. References DBG_PREFIX, DBG_WARN, FUNC_ENTER, MTAG_SENUMERATE, and ParPortEnumerateClose().

---