Owner manual
Table Of Contents
- REGISTERED TO ISO 9001:2000
- SECTION 1. OVERVIEW
- SECTION 2. SYSTEM REQUIREMENTS
- SECTION 3. INSTALLATION
- INSTALLING THE MCP DRIVER
- CHANGING THE MCP DRIVER:
- REMOVING THE MCP DRIVERS
- DEVICE INSTANCE MANAGEMENT
- Device Instance Overview
- MCPCFG Utility Overview
- MCPCFG Command Summary
- Adding a Device Instance from Command Line – RS-232
- Adding a Device Instance from Command Line – USB
- Adding a Device Instance from Windows Based Application (WINDOWS 2000, XP) – RS-232
- Adding a Device Instance from Windows Based Application (WINDOWS 2000, XP) – USB
- Modifying a Device Instance Properties from Windows Based Application (WINDOWS 2000, XP) – RS-232 and USB
- Removing a Device Instance from Windows Based Application (WINDOWS 2000, XP) – RS232
- Removing a Device Instance from Windows Based Application (WINDOWS 2000, XP) – USB
- Removing a Device Instance from a Command Line – RS-232
- Removing a Device Instance from a Command Line – USB
- Displaying the List of Device Instances from Command Line
- Displaying Device Instance Properties from Command Line
- Modifying Device Instance Properties from Command Line
- Modifying Device Instance Properties From Windows Based Application
- Restarting the MCP Driver
- Stopping the MCP Driver From Command Line
- Windows Configuration Utility
- DEVICE INSTANCE PROPERTIES
- SECTION 4. TRACE LOG
- SECTION 5. APPLICATION PROGRAMMABLE INTERFACE
- TYPICAL OPERATION
- DEVICE CHANNEL LIFE CYCLE
- PROPERTIES
- COMMANDS
- NOTIFICATIONS
- FUNCTIONS
- Summary
- MCPBUS Structure
- Members
- Remarks
- The MCPBUS is used as an input parameter to many of the MCP API functions. The MCP driver modifies only those members explicitedly defined by the individual functions. For example, the API will not modify the lpOutBuffer or dwOutBufferSize members (the buffer that lpOutBuffer points to will of course be modified); therefore, the caller may set these values once and not need to reset them prior to invoking subsequent MCP API functions. The only structure members modified by an MCP API function are those explicitly identified as output parameters.
- McpEnum
- McpOpen
- McpClose
- McpReset
- McpGet
- McpCall
- McpWait
- CONSTANT DEFINITIONS
- FUNCTION PROTOTYPES
- INDEX
MagTek Communications Protocol, Driver Reference Manual
68
The following structure members are used as output parameters.
Member Meaning
dwApplicationID ID of the device application generating the notification
dwCommandID ID of the notification (application specific)
dwResultCode Result Code.
lpOutBuffer The buffer pointed to by this member contains the returned notification
data
dwResponseLen Length (in bytes) of notification data returned in buffer pointed to by
lpOutBuffer
Return Value
Value Meaning
MCP_ST_OK Success. Notification data is in the Output Buffer.
MCP_ST_NOT_FOUND No notifications found (valid only if dwTimeout was zero)
MCP_ST_TIMEOUT No notification arrived within the specifiec dwTimeout period
Remarks
This function can be used to retrieve the next notification message which the driver has received
and buffered from device. How the driver is to returned from this function call depends on the
dwTimeout member:
1) If one just wants to poll the driver to determine whether there are any notifications in
the queue, 0 would be specified so that the function would return immediately with
the next notification if one was queued or with an error code indicating that no
notifications were buffered.
2) If one wanted to retrieve the next queued notification or wait (for no longer than a
finite period of time) until the next notification arrives, a positive non-zero value
would be specified.
3) If one wanted to retrieve the next queued notification or wait indefinitely until the
next notification arrives, a "–1" value would be specified.
If the caller wishes to discard all queued notifications and only wait for the next new notification
message, the MCP_ATTR_WAIT_NEW flag should be set in the dwOperAttribute prior to
calling the McpWait function.