Symbol

Accessor base class provides access to an entry within an Accessable object.

Accessor constructor.

The index for an entry within an Accessable object.

An integer field that contains the location of the entry within an Accessable object.

Get the index of the Accessor.

UintAccessor class provides access to a uint within an Accessable object.

UintAccessor constructor.

The index of the Accessor.

BoolAccessor class provides access to a bool within an Accessable object.

BoolAccessor constructor.

The index of the Accessor.

ObjectAccessor class provides access to a generic object within an Accessable object.

ObjectAccessor constructor.

The index of the Accessor.

StringObjectAccessor class provides access to a string object within an Accessable object.

StringObjectAccessor constructor.

The index of the Accessor.

UintObjectAccessor class provides access to a uint object within an Accessable object.

UintObjectAccessor constructor.

The index of the Accessor.

FloatObjectAccessor class provides access to a Float object within an Accessable object.

FloatObjectAccessor constructor.

The index of the Accessor.

The API Base class provides a common foundation for all classes that in the EMDK for .NET class libraries that will work with the StandardForms functionality.

The API class provides the capability of "reflecting" through objects to gain information at runtime about their properties. This capability provides an excellent way for application developers to create UI for parameters they may not necessarilly be familiar with. This class is abstract and as such may never be instantiated as is.

Default API constructor.

Abstract method that provides the capability of saving an API objects properties/parameters.

A boolean flag that when true performs a deep copy of the parameters, otherwise a shallow copy is performed. An object that represents the saved parameters is returned.

Abstract method provides the capability to restore previously saved API object parameters.

An object that represents the saved API parameters.

Returns all parameter/property information for the API object.

An array of PropertyAttributes are returned. The array contains all the properties with meta-data that can be used for UI purposes.

Returns all parameter/property information for the API object.

A boolean flag that specifies whether or not to return optional parameters in the PropertyAttribute array. An array of PropertyAttributes are returned. The array contains all the properties with meta-data that can be used for UI purposes.

This method can be used to obtain subclass information for nested API derived objects within an API object.

The class type of the Parent Class. The class type of the Child Class. Returns an PropertyClassAttribute object for a given class type.

The text property provides a inherited class specific string.

A string that describes the API object.

A virtual property that may or may not be overridden for a derived API object.

A boolean flag. Returns true if not overridden.

Provides the ability to saving and restoring of API object parameters.

An InfoChanges object that performs actions on the API object.

The InfoChanges class is used internally to help with the saving and restoring process.

The InfoChanges class is created by the API abstract class and is used to provide the recursive save feature. The InfoChanges object can be access using API.Changes property.

InfoChanges constructor is called internally to the class libraries.

An API based object to save and restore information.

Saves all properties/parameters for the given API object recursively.

An object that represents the saved parameters.

Saves all properties/parameters for the given API object.

A boolean flag. If true a deep copy of the parameters will be made, otherwise a shallow copy will be made. An object that represents the saved parameters.

Abstract method provides the capability to restore previously saved API object parameters.

An object that represents the saved API parameters.

The PropertyNameAttribute class is an attribute that is used to tag properties in API objects with a friendly name for use with the UI.

The StandardForms classes use the information provided by this attribute for user interface purposes.

PropertyNameAttribute constructor with settable name. Optional flag is set to false.

A string that contains the name of the property.

PropertyNameAttribute constructor with settable name and optional flag.

A string that contains the name of the property. A boolean flag that determines whether or not the property is optional.

PropertyNameAttribute constructor with settable name and resource information.

A string that contains the name of the property. A string that contains the location of the resource file with name information.

PropertyNameAttribute constructor with settable name, optional flag, and resource file information.

A string that contains the name of the property. A string that contains the location of the resource file with name information. A boolean flag that determines whether or not the property is optional.

The friendly name of the PropertyNameAttribute.

A string that contains the friendly name.

Specifies whether or not the parameter/property is optional.

A boolean flag that indicates the optional status of the parameter.

The HelpTextAttribute class is used to tag properties with a help string that can be used in applications as a tool tip.

The StandardForms classes use the information provided by this attribute for user interface purposes.

HelpTextAttribute constructor with settable help text string.

A string of help text.

The help text string.

A string of help text.

The PropertyTypeAttribute class is used to tag properties in API objects with information about the type of information they contain.

The StandardForms classes use the information provided by this attribute for user interface purposes.

The PropertyTypeAttribute constructor with settable type and its associated name.

The type of the property. The name associated with the type.

The type of the property.

A type object that specifies the type of the property.

A friendly name for the property type.

A string with the name of the property type.

Specifies whether or not the property is an enumerated type.

A boolean flag that indicates if the property is an enumerated type.

Specifies whether or not the property is a uint.

A boolean flag that indicates if the property is a uint.

Specifies whether or not the property is a int.

A boolean flag that indicates if the property is a int.

Specifies whether or not the property is a bool.

A boolean flag that indicates if the property is a bool.

Specifies whether or not the property is a string.

A boolean flag that indicates if the property is a string.

Specifies whether or not the property is a value-type.

A boolean flag that indicates if the property is a value-type.

The PropertyReadOnlyAttribute class is used to tag properties in API objects with information about whether or not the information it provides is read only (Cannot be set).

The StandardForms classes use the information provided by this attribute for user interface purposes.

The PropertyReadOnlyAttribute constructor with settable state.

A boolean flag that specifies whether or not the property is read only.

Specifies whether or not the property is read only.

A boolean flag that indicates if the property is read only.

The PropertyRangeAttribute class is used to tag properties in API objects with information about the range of possible values that the property can be.

The StandardForms classes use the information provided by this attribute for user interface purposes.

The PropertyRangeAttribute constructor with settable minimum and maximum values.

The minimum possible integer that the property can be. The maximum possible integer that the property can be.

The PropertyRangeAttribute constructor with settable minimum, maximum, and incremental values.

The minimum possible integer that the property can be. The maximum possible integer that the property can be. An integer that specifies how much to increment or decrement when presenting values between min and max to the user.

The minimum possible integer that the property can be.

The maximum possible integer that the property can be.

An integer that specifies how much to increment or decrement when presenting values between min and max to the user.

An integer with information on how much to increment or decrement through the range of valid property values.

The PropertyClassAttribute class is an attribute that is used to tag properties in API objects that return subclass API objects.

Using the PropertyClassAttribute tag on a property provides a mechanism for nesting API classes within eachother. By enumerating the properties tagged with this attribute, the UI can then recurse down through all the meta-data and provide an extensive UI for setting/getting parameters.

PropertyClassAttribute constructor is called internally to the class libraries with settable index number.

A Type object that specifies the type of class. A string that specifies a friendly name to call the property for UI purposes. An integer index number associated with the attribute.

PropertyClassAttribute constructor is called internally to the class libraries.

The index number is set to 0. A Type object that specifies the type of class. A string that specifies a friendly name to call the property for UI purposes.

A Type object that specifies the type of class.

A Type object.

A string that specifies a friendly name to call the property for UI purposes.

A string.

An integer index number associated with the attribute.

An integer.

The PropertyValueAttribute class is used to tag properties in API objects with information about the values the property can be.

The StandardForms classes use the information provided by this attribute for user interface purposes.

The PropertyValueAttribute constructor with settable value name and its associated number.

A string that contains the name of the value. A number that is associated with the value name.

Compares two property attributes.

A boxed PropertyValueAttribute to compare. If the int value associated with each PropertyValueAttribute is equal 0 is returned. -1 is returned if the value of the PropertyValueAttribute passed in as a parameter is greater. 1 is returned if the value of the PropertyValueAttribute passed in as a parameter is less.

The friendly name of the PropertyValueAttribute.

A string that contains the PropertyValueAttribute name.

A number associated with the PropertyValueAttribute.

A int number associated with the PropertyValueAttribute.

A boxed object associated with the PropertyValueAttribute.

The PropertyAttribute class encapsulates all tagged attributes for a property. This class provides a means to obtain information about all the attributes. This class is normally instantiated by the method.

The StandardForms classes use the information provided by this attribute for user interface purposes.

PropertyAttribute constructor with settable owner.

A Symbol.API object that owns the property that will be tagged with the PropertyAttribute.

Gets the Index of the PropertyAttribute ValueList. The location of the property value in the ValueList.

The index location of the property value in the ValueList.

Gets the Index of the PropertyAttribute ValueList. The location of the property value in the ValueList.

The API object that contains the property. The index location of the property value in the ValueList.

Gets the value of the property as a uint.

The uint value of the property.

Gets the value of the property as a uint.

The API object that contains the property. The uint value of the property.

Gets the value of the property in integer form.

The value of the property.

Gets the value of the property in integer form.

An API object to get the value from. The value of the property.

Get the value of the property in boolean form.

A boolean flag with the property value.

Get the value of the property in boolean form.

An API object to get the value from. A boolean flag with the property value.

Get the value of the property in string form.

A string that contains the value of the property.

Get the value of the property in string form.

An API object to get the value from. A string that contains the value of the property.

Get the subclass that the property contains.

An API object that is nested within an API object.

Get the subclass that the property contains.

An API object to get the value from. An API object that is nested within an API object.

Sets the Index of the PropertyAttribute to an item in the ValueList.

The index of the value in the value list.

Sets the Index of the PropertyAttribute to an item in the ValueList.

The API object that contains the property to be set. The index of the value in the value list.

Sets the value of the property. The value is a boxed object.

A boxed object that contains the value.

Sets the value of the property. The value is a boxed object.

An API object that contains the property to set. A boxed object that contains the value.

FindPropertyByString static method provides a way to obtain the a PropertyAttribute of a property given a PropertyAttribute list and its friendly name.

An array of PropertyAttributes. Normally obtained using the method. A string that contains the friendly name of the propery. A PropertyAttribute for the found property metadata otherwise null.

Obtain the index of a value string.

A value string. An integer that contains the index of the value string if found, otherwise -1 is returned.

Gets the owner of the tagged property.

A Symbol.API object that owns the tagged property.

Gets a PropertyInfo object that allows for the discovery of property attributes and provides access to property metadata.

A System.Reflection.PropertyInfo object associated with the API object.

Gets a PropertyNameAttribute with information about the name of the property.

A PropertyNameAttribute object.

Gets a HelpTextAttribute with information about a property help string (if present).

A HelpTextAttribute object.

Gets a PropertyTypeAttribute with information about the type of the property.

A PropertyTypeAttribute object.

Gets a PropertyReadOnlyAttribute with information about the read state of the property.

A PropertyReadOnlyAttribute object.

Gets a PropertyRangeAttribute that contains information about the range of valid values that the property can take.

A PropertyRangeAttribute object.

Gets a PropertyClassAttribute that specifies whether or not the property is an API object that contains properties of its own.

A PropertyClassAttribute object.

Gets a PropertyValueAttribute array that contains all the possible values for a given property.

A PropertyValueAttribute array.

Returns an array of strings that represent the different values the property can take.

An array of strings for the different value names.

Specifies whether or not the property is a uint.

Specifies whether or not the property is a int.

Specifies whether or not the property is an enumerated type.

Specifies whether or not the property is a bool.

Specifies whether or not the property is a string.

Specifies whether or not the property is Read only.

Specifies whether or not the property is a value-type.

Specifies whether or not the property is a subclass that contains its own property metadata.

Specifies whether or not the property has an associated help text string.

A boolean flag that is true if a help text string is present.

Specifies whether or not the property contains information strings for each value. This is usually the case for enumerated values.

A boolean flag that is true if the property has value strings.

Specifies whether or not the property contains a list of valid values.

A boolean flag that is true if the property has a list of valid value.

Enumerated type that maps its members to underlying C API return codes.

The task was successful.

The task was cancelled.

The device is not enabled.

The task is pending.

Incorrect parameter sent to MSR C API.

Incorrect buffer size for MSR C API.

No data read from MSR C API.

An Operating System error occured while accessing MSR C API.

MSR hardware was removed.

A Scanner error occurred opening the active driver registry key.

A Scanner error occurred reading the active driver registry key.

A Scanner error occurred opening the registry key containing the driver's settings.

A Scanner error occurred reading the registry key containing the driver's settings.

An attempt to allocate memory for scanner failed.

An invalid scanner device context ID was used.

An attempt was made to access an invalid scanner open context.

The scanner driver was accessed before a successful initialization.

The physical device driver (PDD) for scanner could not be loaded.

The physical device driver (PDD) DLL for scanner did not contain the required entry points.

Required scanner device is not present, already in use or not functioning properly.

The scanner device could not be started.

The default scanner parameters could not be obtained from the physical device driver (PDD).

An attempt was made to use or stop the scanner device and it was not started.

An attempt was made to start the scanner device when the device was already started.

An attempt was made to access the scanner device and it was not enabled.

An attempt was made to enable scanning when scanning was already enabled.

The control code passed to DeviceIoControl of the scanner is invalid.

A NULL pointer was passed for a required argument.

A passed argument is out of range.

The size of the buffer passed as an input to DeviceIoControl is less than sizeof(STRUCT_INFO) or is less than the size specified in StructInfo.dwUsed.

The size of the buffer passed as an output to DeviceIoControl is less than sizeof(STRUCT_INFO) or is less than the size specified in StructInfo.dwAllocated.

A STRUCT_INFO structure field is invalid. Either dwAllocated or dwUsed is less than the size of STRUCT_INFO or dwUsed is greater than dwAllocated.

The size of a structure specified in a StructInfo is too small to contain a required field.

An invalid handle was passed to a function.

The value of a parameter either passed as an argument to a function or as a member of a structure is out of range or conflicts with other parameters.

Unable to create a required event.

Unable to create a required thread.

A read request was cancelled.

A read request timed out.

Attempt to cancel a read that is not pending.

Attempt to start a read when one is pending.

Data buffer is too small for incoming data.

Attempt to access fields of an invalid scan buffer.

Attempt to submit a read that is incompatible with reads already queued.

Attempt to perform physical device driver (PDD) feedback with no feedback capabilities.

Version of function not supported (e.g. ANSI vs. UNICODE).

The requested operation is inconsistent with the current state of the device.

No more items are available to be returned from SCAN_FindFirst/SCAN_FindNext.

A required registry key could not be opened.

A required registry value could not be read.

An exception occurred while trying to call the scanner driver.

A scanner API function failed with a non-scanner API error code. Call GetLastError to get extended error code.

A requested scanner resource is already in use.

The specified scanner resource was not allocated.

The specified decoder DLL can not be loaded.

At least one API is missing in Decoder DLL.

The symbol's format is invalid.

The platform does not have a valid license key.

The scanned macro symbol is not part of the current macro sequence.

The scanned macro symbol has already been scanned into the current macro sequence.

The Image HAL DLL can not be loaded.

At least one API function is missing in Image HAL DLL.

The Image Compression DLL can not be loaded.

I2C communication failed.

Camera security policy not allowing to use camera.

The specific RSM attribute number is not valid on scanner.

Invalid response received from scanner.

Missing configuration details.

The function completed successfully.

Global parameter error.

An error occurred due to invalid parameter.

The MSR API is not opened (call MSR_Open).

The MSR API is already opened.

An error occurred while allocating memory.

Card information read is greater than 400 bytes.

Unable to access the MSR device. Usually occurs when the device is not connected to the Serial I/O port.

Erroneous response from the MSR device.

Timeout occurred while waiting for response from MSR device.

MSR device ROM error.

MSR device RAM error.

MSR device EEPROM error.

Reserved error value.

Check sum error.

Read failed.

Read succeeded, no data.

A NULL parameter pointer passed as a parameter.

MSR device is still busy in previous function state.

MSR device failed to wake up.

Application trying to read buffered mode data while the MSR device is still in unbuffered mode.

Application trying to read unbuffered mode data while the MSR device is still in buffered mode.

A failure in Serial I/O Function.

Failure to open the MSR device.

An asynchronous close due to low battery voltage.

Power is switched off to MSR device during the execution of the driver function call.

If the driver function returns error due to Operating System

Options class provides the capability of setting parameters that effect that way in which the EMDK for .NET class libraries work.

The Options class can be used to select how the class libraries should handle errors that are not necessarilly fatal, but may be useful to customer during development.

Turn on/off debug mode exceptions.

A boolean flag that when set to true enables exceptions to be thrown in situations that are not fatal but may lead flag issues that should be addressed prior to an application's release.

A helper class that provides a way in which applications can determine how long tasks are taking.

This class is not as accurate as a Performance Counter. It should be used for rough estimations only.

Start stopwatch.

Stop stopwatch

A TimeSpan object with time elapsed information.

UnimplementedFunctionException is thrown when a method is not available for use.

Derived off of the System.Exception class, this exception provides no additional functionality over its derived class.

UnimplementedFunctionException constructor with settable string.

A string the contain information about the exception.

WrongMarshalSizeException is thrown when marshalling fails to work correctly. In particular, when a size of the marshaled buffer is not the correct size.

Derived off of the System.Exception class, this exception provides no additional functionality over its derived class.

WrongMarshalSizeException constructor with settable string.

A string the contain information about the exception.

OperationFailureException is thrown when a failure occurs in the class libraries. This failure usually is one that stops the proper functioning of the class libraries.

Derived off of the System.Exception class, this exception provides a results enum or integer to be associated with the exception. The number is returned in integer form via the Result property.

OperationFailureException constructor with settable string and results enum.

A string the contains information about the exception. A Results enumerated type that contains information about the exception.

OperationFailureException constructor with settable string and integer value.

A string the contains information about the exception. A integer that contains information about the exception.

The number associated with the exception.

An integer result that contains information about what caused the exception.

InvalidUsageException is thrown when a class library method or property is not used correctly.

Derived off of the System.Exception class, this exception provides no additional functionality over its derived class.

Default InvalidUsageException constructor.

InvalidUsageException constructor with settable string.

A string that contains information about the exception.

InvalidDataTypeException is thrown when a class library accesses an invalid data type.

Derived off of the class, this exception provides no additional functionality over its derived class.

Default InvalidDataTypeException constructor.

InvalidDataTypeException constructor with settable string.

A string that contains information about the exception.

InvalidRequestException is thrown when a class library trys to perform an invalid request.

Derived off of the class, this exception provides no additional functionality over its derived class.

Default InvalidRequestException constructor.

InvalidRequestException constructor with settable string.

A string that contains information about the exception.

InvalidIndexerException is thrown when a class library trys to access an invalid indexer.

Derived off of the class, this exception provides no additional functionality over its derived class.

Default InvalidIndexerException constructor.

InvalidIndexerException constructor with settable string.

A string that contains information about the exception.

DebugModeException is thrown when a class library trys to perform functions that are invalid but not fatal.

Derived off of the System.Exception class, this exception provides the capability of associated the exception with an integer.

DebugModeException constructor with settable string and integer information.

A string that contains information about the exception. An integer that contains information about the exception.

The number associated with the exception.

An integer result that contains information about what caused the exception.

DebugModeUnsupportedEnumValue is thrown when a class library trys to access an enumerated type that is not valid.

Derived off of the class, this exception provides no additional functionality.

DebugModeUnsupportedEnumValue constructor with settable string and integer information.

A string that contains information about the exception. An integer that contains information about the exception.

The Generic.Device class provides the basic functionality needed to obtain a list of available devices.

This class is normally used to derive a specific class that contains more detailed device information. The basic information exposed by this class is used by the StandardForms UI to create device lists that are independent of the type of the devices in the list.

Default Generic.Device class constructor creates a Device object that contains null strings ("") for both the friendly and device names.

Device class constructor with settable Device and Friendly names.

A string that contains the name of the device. (Example: "SCN1:" for the first barcode reader). A string that contains the friendly name of device. This parameter is used for UI purposes to present more user friendly information

Returns the device name for the device.

A string that contains the device name.

Provides read/write access to the device name of the device.

A string that contains the device name.

Provides read/write access to the friendly name of the device.

A string that contains the friendly name.

Returns the device name for the device.

A string that contains the device name.

Returns the static standard name for a simulated device.

A string that contains "Simulate".

The Generic.ReaderData base class provides all common functionality that is used by all ReaderData objects.

The Generic.ReaderData object can be used to perform common actions on a specific ReaderData (such as Barcode.ReaderData or MagStripe.ReaderData). This allows common code to be created that acts on any ReaderData.

Releases all native resources back to the system.

This method should be called when the ReaderData object is no longer needed by the application.

Returns information about the status of the ReaderData.

A member of the Results enumerated type.

Returns the data read from the device.

A string that contains the data read from the device.

Returns information about the device that is providing the data. This is usually the device name for the device.

A string that contains the source information.

Returns the time at which the data was acquired.

A DateTime structure that contains the time information.

The Generic.Actions base class provides access to common methods that are used by all Generic.Reader objects.

The Generic.Actions object can be used to perform common actions on a specific Reader (such as Barcode.Reader or MagStripe.Reader). This allows common code to be created that acts on any Reader.

Puts the device in a state in which information can be read from the device.

This method is abstract and therefore is implemented by the derived class.

Puts the device in a state in which information can no longer be read from the device.

This method is abstract and therefore is implemented by the derived class.

Removes all pending reads from the device.

This method is abstract and therefore is implemented by the derived class.

Initiates a read from the device. This method simply puts the class in a state in which data can be read. Commonly, some other action must take place before the read will actually complete (such as pressing a scan trigger or swiping a magnetic striped card).

A Generic.ReaderData object that will contain the data.

Returns a new Generic.ReaderData object that can be used with the Generic.Read function.

A new Generic.ReaderData object.

Releases all native resources back to the system.

This method is normally called by the derived classes that instantiate the object.

The Generic.Reader base class provides access to common functionality that exists across different data providers (such as barcode readers and MSR readers).

The Generic.Reader object can be used to perform common actions on a specific Reader (such as Barcode.Reader or MagStripe.Reader). This allows common code to be created that acts on any Reader.

Resources will be freed up during a call to this method.

This method is abstract and therefore is implemented by the derived class.

Gets the next Generic.ReaderData object from the read completion queue.

The GetNextReaderData method is most commonly called by methods that have been invoked via the ReadNotify event. This method provides access to the ReaderData object of completed reads (whether the reads have been completed successfully or not should be determined from the status information provided by the ReaderData object). A object that has completed.

Internal field, should not be used.

Allows various operations to be performed for the reader.

A Generic.Actions object that provides the standard actions that can be performed on a Generic.Reader.

Attach to this notification event to be called back when a generic read completes.

A System.EventHandler delegate of the method that will be invoked when a read completes.

Generic Controller Base Class used by derived objects that will certain hardware.

Used by the Display and Audio classes, the Controller class provides a common set of functionality for hardware controllers. This class is abstract that therefore cannot be instantiated on its own.

Controller Constructor is called by the derived class.

A Generic.Device object that provides information on what hardware to control.

The derived class should implement a mechanism for saving parameters if necessary. Otherwise, this method will return null.

A boolean flag that specifies whether or not to perform a deep copy of object. A new object that represents the saved parameters.

The derived class should implement a mechanism for restoring any parameters that have been saved using the method. Otherwise, this method will do nothing.

An object that contains the saved parameters.

Internal field, should not be used.

Resources will be freed up during a call to this method.

This method is abstract and therefore is implemented by the derived class.

MarshalObject abstract base class provides a the capability of defining an object that can be passed between native and managed code or vice versa.

The MarshalObject is most commonly used to derive classes that will take the form of certain members inside of structures. (Examples: StringObject, FloatObject, etc.) These derived classes are used to fully describe the structure that will be marshalled.

The MarshalTo method must be implemented by the derived class. When implemented, the method takes the managed information and marshals it into a native buffer that can be used with native function calls.

An IntPtr to a native buffer. An integer value that indicates where in the native buffer the marshalled data should start being copied to. An integer offset that indicates where the next item can be placed in the native buffer. (ie the incremented offset).

The UnmarshalFrom method must be implemented by the derived class. When implemented, the method takes the native buffer and unmarshals it into managed information that can be used by the class libraries.

An IntPtr to a native buffer. An integer offset from which to begin unmarshalling the data. An integer offset that indicates where the next item can be unmarshalled from the native buffer. (ie the incremented offset)

Creates a native buffer for use with the Symbol derived marshal object class. The native buffer size is based off of the property.

If the allocation fails the IntPtr is still returned, but the value it contains will be zero. (ie null) An IntPtr that points to the new native buffer.

Frees the native buffer of the marshal object.

An IntPtr that points to the native buffer.

The size in bytes of the native type that the marshal object represents.

An integer that contains the amount of bytes of the native type.

Specifies whether or not the marshal object contains a StructInfo structure inside the native structure to be marshaled.

By knowing that the marshal object contains a StructInfo inside the native structure, the internal marshalling functions automatically strip out the information. A boolean flag the specifies if the marshal object contains a StructInfo.

GapObject class is used to represent gaps in a native structure. These gaps do not necessarilly need to be marshaled.

The gaps indicated by GapObjects provide a mechanism in which certain locations within a native structure can be skipped so that marshalling the structure using a cascade approach can still work.

GapObject constructor with settable byte length.

An integer that contains the number of bytes in the gap.

The MarshalTo method for a GapObject simply increments the returned offset by the gap length.

The UnmarshalFrom method for a GapObject simply incremetns the returned offset by the gap length.

UintObject class is used to represent byte based or unsigned numbers in a native structure.

The UintObject can handle 4,2,1 (DWORD, WORD, and BYTE) sized numbers. This class is not CLS compliant and will not work with some .NET programming languages.

Default UintObject constructor. By default, the number represented is set to zero and the size is set to 4 bytes.

UintObject constructor with settable initial number. The size is set to 4 bytes.

An integer that represents the number to be marshalled.

UintObject constructor with settable number and size.

An integer that contains the number information. An integer that contains the size in bytes of the number. Must be either 4,2,1. If it is not one of those values a WrongMarshalSizeException will be thrown.

The MarshalTo method for a UintObject sets the managed code number into the native buffer.

The UnmarshalFrom method for a UintObject obtains information about the number from the native buffer.

Read/Write property that contains information about the number that the UintObject represents.

An uint that contains the value of the UintObject.

FloatObject class is used to represent float based numbers in a native structure.

The FloatObject is used by accessable classes to indicate that a float object is present in the native structure. The float object knows how to marshal and unmarshal itself.

Default FloatObject constructor. Sets the float number associated with the object to 0.0f.

FloatObject constructor with settable initial float value.

The initial float value of the FloatObject.

The MarshalTo method for a FloatObject sets the managed code number into the native buffer.

The UnmarshalFrom method for a FloatObject obtains information about the number from the native buffer.

The size in bytes of the float that the float object represents.

An integer that contains the amount of bytes of the float.

Read/Write property that contains information about the number that the UintObject represents.

An float that contains the value of the FloatObject.

StringObject class is used to represent strings in a native structure.

The StringObject can handle different length strings in both ASCII (1 byte per char) and Unicode (2 bytes per char) format. This class is not CLS compliant and will not work with some .NET programming languages.

Default StringObject constructor. By default, the string is set to "", the size of the string is set to MAX_PATH (260 characters), and the string is Unicode.

StringObject constructor with settable initial string. The size is set to MAX_PATH (260 characters), and the string is Unicode.

A string that contains the initial value that the StringObject represents.

StringObject constructor with settable string length. The initial string is set to "" and the string is Unicode.

The size in characters of the string.

StringObject constructor with settable string type. The initial string is set to "" and the length is set to MAX_PATH (260 characters).

A boolean flag that when true indicates that the string is an ASCII string.

StringObject constructor with settable initial string and character length. The string type is set to Unicode.

A string that contains the initial value that the StringObject represents. The size in characters of the string.

StringObject constructor with settable character length and string type. The initial string is set to "".

The size in characters of the string. A boolean flag that when true indicates that the string is an ASCII string.

StringObject constructor with settable initial string, character length, and string type.

A string that contains the initial value that the StringObject represents. The size in characters of the string. A boolean flag that when true indicates that the string is an ASCII string.

The MarshalTo method for a StringObject copies the managed code string into the native buffer.

The UnmarshalFrom method for a StringObject gets a string from the native buffer.

Read/Write property that contains the string that the StringObject represents.

String that will be marshaled.

Specifies whether or not the string is an ASCII or Unicode string.

A boolean flag. When true the string is ASCII, otherwise it is Unicode.

Specifies the maximum length of the string in characters.

An integer that represents the number of characters in the string.

The Accessable base class is used by any derived class that encapsulates a native structure.

The Accessable class is derived from marshal object and therefore provides both a MarshalTo and UnmarshalFrom capability. Commonly an object derived from Accessable is accessed using the Indexers provided by this class. The index to indexers are constants that provide location information as to where in the native structure a MarshalObject resides. The derived Accessable object ususally takes on the form of an array of MarshalObjects that define the native structure in managed code.

Internal field, when set specifies that the object has been modified.

Internal field, specifies the current offset in the native buffer.

Internal field, specifies an array of uint's. This array should not be used on new accessable objects. Replace with UintObject.

Internal field, specfies an array of MarshalObjects, boxed.

Default Accessable constructor. No internal uints or objects instantiated during the construction process.

Accessable constructor with settable number of uint (DWORD) parameters.

An integer that contains the number of DWORDs in the native buffer that the Accessable object represents.

Accessable constructor with settable number of DWORD members and the offset within the native buffer where they reside.

An integer that contains the number of DWORDs in the native buffer that the Accessable object represents. The offset within the native buffer where the DWORDs reside.

Accessable constructor with settable number of DWORD members and an array of marshal objects that represent the native buffer in managed code.

An integer that contains the number of DWORDs in the native buffer that the Accessable object represents. An array of Marshal objects.

Accessable constructor with settable number of DWORD members, the offset within the native buffer where they reside, and an array of marshal objects that represent the native buffer in managed code.

An integer that contains the number of DWORDs in the native buffer that the Accessable object represents. The offset within the native buffer where the DWORDs reside. An array of Marshal objects.

Accessable constructor that creates a clone of the given accessable object.

An Accessable object to create a copy of.

The MarshalTo method for an Accessable object cascades through all of the marshal objects and DWORD and copies their values from managed code to the native buffer.

The UnmarshalFrom method for an Accessable object cascasdes through all the marshal objects and DWORD entries, copying native information into the managed objects along the way.

A number that represents the amount of uints in the Accessable object.

This method of marshalling is no longer used. UintObjects are used to represent DWORD entries. The number of DWORD entries in the Accessable object

A flag that is set when any objects in the Accessable object are changed.

A boolean flag that indicates whether or not any objects have changed.

Gets/sets the object array in the Accessable object.

A boxed MarshalObject array that provides a managed representation of the native structure.

Legacy call obtains all uints in the Accessable object.

This method of marshalling is no longer used. UintObjects are used to represent DWORD entries. An array of uints.

An indexer that returns the information of the indexed DWORD entry.

Integer that contains the value of the indexed DWORD.

A UintAccessor indexer that returns the uint information of the indexed entry.

Integer that contains the value of the indexed entry.

A BoolAccessor indexer that returns the bool information of the indexed entry.

A boolean flag that contains the value of the indexed entry.

A ObjectAccessor indexer that returns the object at the indexed location.

An object at the indexed location.

A UintObjectAccessor indexer that returns the uint at the indexed location.

A uint at the indexed location.

A StringObjectAccessor indexer that returns the string at the indexed location.

A string at the indexed location.

A FloatObjectAccessor indexer that returns the float at the indexed location.

A float at the indexed location.

Microsoft class that allows for native notifications within managed code.

MessageWindow constructor.

Subclass MessageWindow to support checking for the appropriate window message and for notifing someone when the appropriate message is received

User Message for MessageWindow notification note custom window messages are after WM_USER = 0x400

SymbolMessageWindow constructor

A MessageWindowNotify delegate.

Perform notification

An object that contains information about the notification.

Get next object in the Queue

An object that contains information about the notification event.

Static add of event handler to event handler base.

The base event handler. The event handler to add to the base.

Static remove of event handler from event handler base

The base event handler. The event handler to remove from the base.

Override the default WndProc behavior to watch for the specific window message. When the message is received, call back and notify the original form that created the message window.

A windows message structure.

Delegate to be called by message window when in UI thread

Resources Class provides the capability of localizing strings so that foreign language support can be implemented.

Not currently used by the Symbol class libraries.

Static method that creates a ResourceManager for use with foreign language string queries.

The type of foreign language. A ResourceManager object that can be used for string queries.

Query the resource managed for a given string, given the ID.

The string ID. The location of the string. The localized string or "Exception" if string is not found.

Gets/Sets the path where the localization information is stored.

A string that contains the path information.

The SymbolMarshal class is used to marshal managed data into native data and vice versa.

This class is not CLS Compliant.

Constant integer contains the size in bytes of a native DWORD.

Constant integer contains the size in bytes of a native WORD.

Constant integer contains the size in bytes of a native BYTE.

Constant integer contains the size in bytes of a native WCHAR.

Constant integer contains the max size in bytes of a native path.

Constant integer contains the max size in bytes of a device name.

The NULL field returns an IntPtr with value 0. Used in marshal operations.

Marshals (copies) managed code structinfo information into the native buffer.

An IntPtr that points to the native buffer. The offset from the start of the native buffer where the struct info resides. The amount of bytes allocated in the native structure defined by the struct info. The amount of used bytes in the native structure as defined by the struct info. An offset that indicates the next part of the native buffer.

Unmarshals (extracts and checks) managed information from the struct info in the native buffer.

Convert DateTime in managed code to native SYSTEMTIME.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. A DateTime object that contains the time information. An offset that indicates the next part of the native buffer.

Convert a native SYSTEMTIME to DateTime in managed code.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. A DateTime object that will contain the time information. An offset that indicates the next part of the native buffer.

Copy managed byte into native buffer.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. That byte value that will be copied to native buffer. An offset that indicates the next part of the native buffer.

Extract managed byte from native buffer.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. That byte value that will be obtained from native buffer. An offset that indicates the next part of the native buffer.

Copy managed byte into native buffer.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. The value that will be copied to native buffer. An offset that indicates the next part of the native buffer.

Extract managed word from native buffer.

Copy managed DWORD into native buffer.

Extract managed dword from native buffer.

Copy managed string into native buffer.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. The string to be set. The size of the string in characters. An offset that indicates the next part of the native buffer.

Copy managed string into native buffer with setttable character width.

An IntPtr that points to the native buffer. The offset from the start of the native buffer. The string to be set. The size of the string in characters. A boolean flag the specifies whether of not string is in bytes or wide characters. (TRUE = bytes) An offset that indicates the next part of the native buffer.

Extract managed string from native.

Allocates a block of native memory.

The size of the native buffer. A managed pointer to the native buffer.

Releases a block of native memory.

A managed pointer to the native buffer.

Constant integer contains the size in bytes of a StructInfo structure.

The Win32 Class provides access to native functionality that has not yet been made available with the .NET Compact Framework.

A native PostMessage Win32 call. Used in the notification process.

The handle to a window. The windows message. WParam LParam Return value.

A native SendMessage Win32 call. Used in the notification process.

The handle to a window. The windows message. WParam LParam Return value.

Open a registry key.

An IntPtr to the key to open. A subkey string. A integer that specifies any options. A reserved integer. Usually 0. The new key that was opened. A return code.

Creates or opens a key in the Registry.

The base key to create or open. A string that contains the subkey. A reserved integer. Usually 0. The string that contains the reg class. Registry options An IntPtr to the new registry key handle. Information about the disposition of the reg key. 0 if success

Set DWORD value to registry

The key to the DWORD in. The value name for the DWORD registry entry. The DWORD value to set in the registry. 0 if success

Set string value in the registry.

Handle to the base registry key. The value name of the string registry entry. The string to be set in the registry. 0 if success

Get a string value from registry.

The registry key where the string value resides. The value name for the string entry. The string obtained from the registry. 0 if success

Get DWORD value from Registry.

The registry key to get dword from. The registry value name. The dword value. 0 if success

Set a registry key.

The registry key to set values in. The value name of the registry key. A reserved integer. The type of the registry key. The data that the registry key will hold. The size of the data that will be set in the registry. 0 if successful.

Enumerate subkeys under a registry key.

Handle to an open key. The key must have been opened with the KEY_ENUMERATE_SUB_KEYS access right. Index of the subkey of hKey to be retrieved. A string receives the name of the subkey 0 if successful.

Close a Registry key

The registry key to close. 0 if successful.

Returns Simulation flag from registry

The name of the device to obtain simulation information for. SimulationFlagType value

Provides access to the Win32 API GetLastError value.

An error code string.

Provides Win32 API Last Error value

last error as integer

Wait for a single event object

A W32Event object Timeout in milliseconds or INFINITE. 0 if successful.

Wait for multiple event objects

Arrary of W32Event objects. Boolean flag that specifies whether all events must be signaled or just one. The timeout in milliseconds or INFINITE. 0 if successful.

Returns the platform type string.

A string that contains platform type information.

Turns on/off the wait cursor

A boolean flag that is true when the wait cursor is on, or false when it is off.

Base registry key handles.

ID for creating a handler to Classes Root section in registry.

ID for creating a handler to Current User section in registry.

ID for creating a handler to Local Machine section in registry.

ID for creating a handler to Users section in registry.

Registry value types

No defined value type.

Null-terminated string. It will be a Unicode or ANSI string, depending on whether you use the Unicode or ANSI functions.

Null-terminated string that contains unexpanded references to environment variables (for example, "%PATH%"). It will be a Unicode or ANSI string, depending on whether you use the Unicode or ANSI functions.

Binary data in any form.

32-bit number.

32-bit number in little-endian format. This is equivalent to REG_DWORD. In little-endian format, a multibyte value is stored in memory from the lowest byte (the "little end") to the highest byte. For example, the value 0x12345678 is stored as (0x78 0x56 0x34 0x12) in little-endian format.

32-bit number in big-endian format. In big-endian format, a multibyte value is stored in memory from the highest byte (the "big end") to the lowest byte. For example, the value 0x12345678 is stored as (0x12 0x34 0x56 0x78) in big-endian format.

Unicode symbolic link.

Array of null-terminated strings that are terminated by two null characters.

Device-driver resource list.

Win32 Event Types

Event has completed due to object 0.

Event has completed due to timeout.

Event has been abandoned.

Wait infinitely.

Signal the event.

Reset the event.

Simulation Flag Types.

Always provide a simulation device in the available device list.

Never provide a simulation device in the available device list.

Only place a simulation device in the device list if no other devices are present.

An error has occurred with simulation.

Registry Disposition types.

A new registry key has been created.

An existing registry key has been opened.

System parameter information request types.

Get the platform type of the OS.

Get the OEM information from the OS.

The W32Event class is used as an alternative to the managed code event mechanism.

The managed code implementation of events does not allow for timeouts. Using the W32Event and the Win32 class Wait functions will provide that functionaliy.

W32Event constructor with settable manual reset and initial state.

A boolean flag the specifies whether or not the event should be reset manually or automatically. A boolean flag the specifies the inital state of the event object. (True = signaled)

W32Event constructor with settable manual reset, inital state and name.

A boolean flag the specifies whether or not the event should be reset manually or automatically. A boolean flag the specifies the inital state of the event object. (True = signaled) The name of the event. This can be used for synchronizing across processes.

Set W32Event.

Boolean flag that specifies whether or not call is successful.

Reset W32Event.

Boolean flag that specifies whether or not call is successful.

Release event handle and other native resources.

Returns the native handle of the event.

An IntPtr that contains the handle for the Win32 native event.