Skip to content

Commit 22185ae

Browse files
committed
xrefs, part 1
1 parent 9b9976f commit 22185ae

34 files changed

+71
-71
lines changed

docs/framework/additional-apis/pos-for-net/adding-plug-and-play-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ ms.custom: pos-restored-from-archive
99

1010
Microsoft Point of Service for .NET (POS for .NET) includes support for Plug and Play devices. By adding Plug and Play support to your Service Objects, applications can become more simple, reliable, and efficient. Service Objects should support it whenever possible.
1111

12-
Implementing Plug and Play support at the Service Object level is very simple. Once you know the hardware ID of your device, simply add a single attribute to your class, [HardwareIdAttribute](ms884523\(v=winembedded.11\).md). The **HardwareId** attribute is used by [PosExplorer](ms884843\(v=winembedded.11\).md) to intelligently filter out Service Objects from the list of available devices depending on the state of the device. If the Service Object has a **HardwareId** attribute that refers to an installed Plug and Play device, but that device is not connected, the Service Object will be excluded from the **PosExplorer** device list. This list is returned when applications call [GetDevices](ms843049\(v=winembedded.11\).md).
12+
Implementing Plug and Play support at the Service Object level is very simple. Once you know the hardware ID of your device, simply add a single attribute to your class, <xref:Microsoft.PointOfService.HardwareIdAttribute>. The **HardwareId** attribute is used by <xref:Microsoft.PointOfService.PosExplorer> to intelligently filter out Service Objects from the list of available devices depending on the state of the device. If the Service Object has a **HardwareId** attribute that refers to an installed Plug and Play device, but that device is not connected, the Service Object will be excluded from the **PosExplorer** device list. This list is returned when applications call <xref:Microsoft.PointOfService.PosExplorer.GetDevices>.
1313

1414
Service Objects may also have more than one **HardwareId** attribute, in which case **PosExplorer** associates a union of all specified devices with the Service Object. It is possible to override the **HardwareId** attributes or add to the list of associated hardware on the Service Object without rebuilding the Service Object assembly. For information about overriding or adding the **HardwareId** attribute, see [Plug and Play XML Configuration](plug-and-play-xml-configuration.md).
1515

16-
Only the application is responsible for catching [DeviceAddedEvent](ms831428\(v=winembedded.11\).md) and [DeviceRemovedEvent](ms831429\(v=winembedded.11\).md) events and updating its status as appropriate based on the updated device list returned from **PosExplorer**. The Service Object does not need to detect these events.
16+
Only the application is responsible for catching <xref:Microsoft.PointOfService.PosCommon.DeviceAddedEvent> and <xref:Microsoft.PointOfService.PosCommon.DeviceRemovedEvent > events and updating its status as appropriate based on the updated device list returned from **PosExplorer**. The Service Object does not need to detect these events.
1717

1818
## To add a HardwareId attribute to your Service Object class
1919

docs/framework/additional-apis/pos-for-net/asynchronous-output-sample.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ The POS for .NET class library handles most of these functions for the Service O
2727

2828
## Example
2929

30-
To output to a **PosPrinter** device, an application will most commonly use the [PrintNormal](ms834873\(v=winembedded.11\).md) method. Notice that the **PosPrinter** Service Object code below does not provide an implementation for this method. Instead, [PrintNormalImpl](ms834872\(v=winembedded.11\).md) is implemented. This method is called by the POS for .NET library for both synchronous and asynchronous output requests.
30+
To output to a **PosPrinter** device, an application will most commonly use the <xref:Microsoft.PointOfService.BaseServiceObjects.PrintNormalOperation> method. Notice that the **PosPrinter** Service Object code below does not provide an implementation for this method. Instead, <xref:microsoft.pointofservice.baseserviceobjects.posprinterbase.printnormalimpl> is implemented. This method is called by the POS for .NET library for both synchronous and asynchronous output requests.
3131

32-
When an application calls an output method, such as **PrintNormal**, the POS for .NET implementation checks the value of the [AsyncMode](ms861869\(v=winembedded.11\).md) property. If this value is **false**, then the POS for .NET library sends the request to **PrintNormalImpl** immediately and waits for it to return. If the value is **true**, however, then the POS for .NET implementation of **PrintNormal** adds the request to an internally managed queue. While there are items in the queue, a POS for .NET managed thread will send each request, in first-in-first-out (FIFO) order, to the device by calling **PrintNormalImpl**. When **PrintNormalImpl** returns, the library implementation will raise an [OutputCompleteEvent](ms831433\(v=winembedded.11\).md) in the application. In short, the same Service Object code can support both synchronous and asynchronous output without ever needing to know which output mode is being used.
32+
When an application calls an output method, such as **PrintNormal**, the POS for .NET implementation checks the value of the <xref:Microsoft.PointOfService.Cat.AsyncMode> property. If this value is **false**, then the POS for .NET library sends the request to **PrintNormalImpl** immediately and waits for it to return. If the value is **true**, however, then the POS for .NET implementation of **PrintNormal** adds the request to an internally managed queue. While there are items in the queue, a POS for .NET managed thread will send each request, in first-in-first-out (FIFO) order, to the device by calling **PrintNormalImpl**. When **PrintNormalImpl** returns, the library implementation will raise an <xref:microsoft.pointofservice.cat.outputcompleteevent> in the application. In short, the same Service Object code can support both synchronous and asynchronous output without ever needing to know which output mode is being used.
3333

3434
```csharp
3535
using System;

docs/framework/additional-apis/pos-for-net/attributes-for-identifying-service-objects-and-assigning-hardware.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.custom: pos-restored-from-archive
77

88
# Attributes for Identifying Service Objects and Assigning Hardware (POS for .NET v1.12 SDK Documentation)
99

10-
POS for .NET uses .NET reflection and .NET attributes to locate Service Object assemblies, identify Service Objects within those assemblies, and finally to associate a Plug and Play device with that Service Object. By leveraging these .NET features, [PosExplorer](ms884843\(v=winembedded.11\).md) can identify Service Objects within an assembly and quickly assess their Plug and Play requirements. The expensive process of loading a .NET assembly is delayed until needed by the application.
10+
POS for .NET uses .NET reflection and .NET attributes to locate Service Object assemblies, identify Service Objects within those assemblies, and finally to associate a Plug and Play device with that Service Object. By leveraging these .NET features, <xref:Microsoft.PointOfService.PosExplorer> can identify Service Objects within an assembly and quickly assess their Plug and Play requirements. The expensive process of loading a .NET assembly is delayed until needed by the application.
1111

1212
In order to provide these features, POS for .NET depends on three different .NET attributes:
1313

@@ -22,9 +22,9 @@ In order to provide these features, POS for .NET depends on three different .NET
2222

2323
#### Reference
2424

25-
[PosAssemblyAttribute](ms884816\(v=winembedded.11\).md)
26-
[HardwareIdAttribute](ms884523\(v=winembedded.11\).md)
27-
[ServiceObjectAttribute](aa460884\(v=winembedded.11\).md)
25+
<xref:Microsoft.PointOfService.PosAssemblyAttribute>
26+
<xref:Microsoft.PointOfService.HardwareIdAttribute>
27+
<xref:Microsoft.PointOfService.ServiceObjectAttribute>
2828

2929
#### Concepts
3030

docs/framework/additional-apis/pos-for-net/capability-properties.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Certain properties cannot be set directly within a Service Object. This comes up
1111

1212
## BaseClass Properties
1313

14-
Microsoft Point of Service for .NET (POS for .NET) **Base** classes have a protected property, **Properties**, for this purpose. This property returns a helper class which has writable versions of the read-only properties implemented in the **Base** class. For example, [PinPadBase](aa460647\(v=winembedded.11\).md) has a property called [Properties](aa459985\(v=winembedded.11\).md) that returns an object of type [PinPadProperties](aa460655\(v=winembedded.11\).md). And this object contains properties used to set various **PinPad**-specific capability properties, such as [CapDisplay](ms860744\(v=winembedded.11\).md).
14+
Microsoft Point of Service for .NET (POS for .NET) **Base** classes have a protected property, **Properties**, for this purpose. This property returns a helper class which has writable versions of the read-only properties implemented in the **Base** class. For example, <xref:Microsoft.PointOfService.BaseServiceObjects.PinPadBase> has a property called <xref:Microsoft.PointOfService.BaseServiceObjects.PinPadBase.Properties> that returns an object of type <xref:Microsoft.PointOfService.BaseServiceObjects.PinPadProperties>. And this object contains properties used to set various **PinPad**-specific capability properties, such as <xref:Microsoft.PointOfService.Scale.CapDisplay>.
1515

1616
## PosCommon Properties
1717

@@ -30,5 +30,5 @@ The Service Object developer should be aware of what the POS for .NET framework
3030

3131
#### Reference
3232

33-
[PinPadProperties](aa460655\(v=winembedded.11\).md)
33+
<xref:Microsoft.PointOfService.BaseServiceObjects.PinPadProperties>
3434
[StatusUpdateEventHandler](aa460916\(v=winembedded.11\).md)

docs/framework/additional-apis/pos-for-net/creating-a-basic-service-object-code-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The previous section, [Setting up a Service Object Project](setting-up-a-service
1111

1212
## To create a simple class template
1313

14-
1. Add **using** directives for the [Microsoft.PointOfService](ms843373\(v=winembedded.11\).md) and [Microsoft.PointOfService.BaseServiceObjects](ms843374\(v=winembedded.11\).md) to the top of the source file.
14+
1. Add **using** directives for the <xref:Microsoft.PointOfService> and <xref:Microsoft.PointOfService.BaseServiceObjects> to the top of the source file.
1515

1616
2. Choose the POS for .NET **Base** class your Service Object will be derived from. The **Base** class you choose is based on the type of POS device for which you are developing this Service Object. (See [POS for .NET Class Tree](pos-for-net-class-tree.md))
1717

@@ -25,7 +25,7 @@ The previous section, [Setting up a Service Object Project](setting-up-a-service
2525
- Major version
2626
- Minor version
2727

28-
5. Create a default public parameterless constructor. This is required for [PosExplorer](ms884843\(v=winembedded.11\).md) to create an instance of your class by using .NET reflection.
28+
5. Create a default public parameterless constructor. This is required for <xref:Microsoft.PointOfService.PosExplorer> to create an instance of your class by using .NET reflection.
2929

3030
## Example
3131

docs/framework/additional-apis/pos-for-net/creating-a-service-object-sample.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.custom: pos-restored-from-archive
1010
Previous topics explained how to create a basic Service Object template with Plug and Play support. This section adds how to create a limited sample with the following new features:
1111

1212
- Necessary abstract methods are implemented so that the sample will compile successfully.
13-
- The Service Object will be recognized by applications using [PosExplorer](ms884843\(v=winembedded.11\).md), for example, the **POS for .NET Test Application** included with the SDK.
13+
- The Service Object will be recognized by applications using <xref:Microsoft.PointOfService.PosExplorer>, for example, the **POS for .NET Test Application** included with the SDK.
1414
- Applications may now invoke methods on the Service Object or access properties, although no useful results will be returned.
1515

1616
## Requirements

docs/framework/additional-apis/pos-for-net/creating-a-working-multithreaded-service-object.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.custom: pos-restored-from-archive
1010
The previous sections provided samples and guides to start your project including:
1111

1212
- Creating a simple template.
13-
- Implementing a Service Object class that can be compiled and seen by the Point Of Service sample application via [PosExplorer](ms884843\(v=winembedded.11\).md).
13+
- Implementing a Service Object class that can be compiled and seen by the Point Of Service sample application via <xref:Microsoft.PointOfService.PosExplorer>.
1414
- Implementing a thread helper class.
1515

1616
This sample combines all of these steps to create a working, multithreaded MSR Service Object class. This sample does not actually read from any hardware. It simply pushes test data through the system. It illustrates, however, how to add code that is specific to your Service Object.

docs/framework/additional-apis/pos-for-net/developing-a-custom-service-object.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Service Objects are typically implemented by independent hardware vendors (IHVs)
3232
Explains the difference between synchronous and asynchronous output to POS devices.
3333

3434
- [Asynchronous Output Sample](asynchronous-output-sample.md)
35-
Implements a simple [PosPrinterBase](aa460669\(v=winembedded.11\).md) Service Object in order to demonstrate how POS for .NET manages asynchronous output.
35+
Implements a simple <xref:Microsoft.PointOfService.BaseServiceObjects.PosPrinterBase> Service Object in order to demonstrate how POS for .NET manages asynchronous output.
3636

3737
- [Statistics Sample](statistics-sample.md)
3838
Implements a sample Service Object that uses the POS for .NET statistics methods.

docs/framework/additional-apis/pos-for-net/developing-a-pos-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Microsoft Point of Service for .NET (POS for .NET) provides classes and tools th
1111

1212
Service Object classes represent POS peripheral devices, supplying the properties, methods, and events that are defined in the Unified Point Of Service (UnifiedPOS) Retail Peripheral Architecture specification.
1313

14-
The [PosExplorer](ms884843\(v=winembedded.11\).md) class lets applications enumerate installed POS devices, instantiate Service Objects for them, and receive Plug and Play events when a POS peripheral device is connected or disconnected.
14+
The <xref:Microsoft.PointOfService.PosExplorer> class lets applications enumerate installed POS devices, instantiate Service Objects for them, and receive Plug and Play events when a POS peripheral device is connected or disconnected.
1515

1616
## In This Section
1717

docs/framework/additional-apis/pos-for-net/deviceinfo-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.custom: pos-restored-from-archive
77

88
# DeviceInfo Class (POS for .NET v1.14 SDK Documentation)
99

10-
The [DeviceInfo](ms884041\(v=winembedded.11\).md) class supplies Microsoft Point of Service for .NET (POS for .NET) applications with information about POS devices and the Service Objects associated with them. The [PosExplorer](ms884843\(v=winembedded.11\).md) methods, [GetDevice](ms843054\(v=winembedded.11\).md) and [GetDevices](ms843049\(v=winembedded.11\).md) return instances of **DeviceInfo**.
10+
The [DeviceInfo](ms884041\(v=winembedded.11\).md) class supplies Microsoft Point of Service for .NET (POS for .NET) applications with information about POS devices and the Service Objects associated with them. The <xref:Microsoft.PointOfService.PosExplorer> methods, [GetDevice](ms843054\(v=winembedded.11\).md) and <xref:Microsoft.PointOfService.PosExplorer.GetDevices> return instances of **DeviceInfo**.
1111

1212
## DeviceInfo Properties
1313

docs/framework/additional-apis/pos-for-net/event-handler-sample.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ This sample code demonstrates several key points:
4545

4646
- Using an **OutputCompleteEvent** event to notify the application that the Service Object has completed an output request.
4747
- Registering event handlers, including using reflection to do so.
48-
- Using [PosExplorer](ms884843\(v=winembedded.11\).md) to search for specific Service Objects.
48+
- Using <xref:Microsoft.PointOfService.PosExplorer> to search for specific Service Objects.
4949

50-
To demonstrate how reflection can be used to discover which events are available on a given object, this code uses the [PosCommon](ms884820\(v=winembedded.11\).md) object returned from [CreateInstance](ms843048\(v=winembedded.11\).md) without first casting it to a **PosPrinter**. In most cases, an application does not need to be generic in that way and so would cast the object as appropriate.
50+
To demonstrate how reflection can be used to discover which events are available on a given object, this code uses the <xref:Microsoft.PointOfService.PosCommon> object returned from [CreateInstance](ms843048\(v=winembedded.11\).md) without first casting it to a **PosPrinter**. In most cases, an application does not need to be generic in that way and so would cast the object as appropriate.
5151

5252
```csharp
5353
// ASYNCAPP.CS

docs/framework/additional-apis/pos-for-net/exception-classes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ ms.custom: pos-restored-from-archive
99

1010
Microsoft Point of Service for .NET (POS for .NET) error handling is implemented through the use of *exceptions*. The four POS for .NET exception classes are as follows:
1111

12-
- [PosException](ms884839\(v=winembedded.11\).md)
13-
- [PosControlException](ms884827\(v=winembedded.11\).md)
12+
- <xref:Microsoft.PointOfService.PosException>
13+
- <xref:Microsoft.PointOfService.PosControlException>
1414
- [PosManagementException](ms884858\(v=winembedded.11\).md)
1515
- [PosLibraryException](ms884854\(v=winembedded.11\).md)
1616

@@ -30,7 +30,7 @@ Standard Unified Point Of Service (UnifiedPOS) error codes are represented by th
3030

3131
## PosLibraryException
3232

33-
**PosLibraryException** is thrown by [PosExplorer](ms884843\(v=winembedded.11\).md). Applications and Service Objects must not throw **PosLibraryException**.
33+
**PosLibraryException** is thrown by <xref:Microsoft.PointOfService.PosExplorer>. Applications and Service Objects must not throw **PosLibraryException**.
3434

3535
## Error Codes
3636

@@ -106,8 +106,8 @@ catch (PosControlException e)
106106

107107
#### Reference
108108

109-
[PosException](ms884839\(v=winembedded.11\).md)
110-
[PosControlException](ms884827\(v=winembedded.11\).md)
109+
<xref:Microsoft.PointOfService.PosException>
110+
<xref:Microsoft.PointOfService.PosControlException>
111111
[PosManagementException](ms884858\(v=winembedded.11\).md)
112112
[PosLibraryException](ms884854\(v=winembedded.11\).md)
113113

docs/framework/additional-apis/pos-for-net/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following documentation can help you use POS for .NET to develop POS applica
2626
- [Copyright Information for POS for .NET v1.14.1](copyright-information-for-pos-for-net-v1141.md)
2727
Provides copyright information about POS for .NET v1.14.1.
2828

29-
- [POS for .NET FAQ](ee406171\(v=winembedded.0\).md)
29+
- [POS for .NET FAQ](pos-for-net-faq.md)
3030
Provides answers to frequently asked questions for POS for .NET.
3131

3232
- [What's New in POS for .NET v1.14 and v1.14.1](whats-new-in-pos-for-net-v114-and-v1141.md)
@@ -80,4 +80,4 @@ The following documentation can help you use POS for .NET to develop POS applica
8080

8181
#### Reference
8282

83-
[Microsoft.PointOfService](ms843373\(v=winembedded.11\).md)
83+
<xref:Microsoft.PointOfService>

docs/framework/additional-apis/pos-for-net/integration-of-legacy-service-objects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Microsoft Point of Service for .NET (POS for .NET) supports both .NET-based Serv
1313

1414
#### Concepts
1515

16-
[POS for .NET FAQ](ee406171\(v=winembedded.0\).md)
16+
[POS for .NET FAQ](pos-for-net-faq.md)
1717
[What's New in POS for .NET v1.14](whats-new-in-pos-for-net-v114-and-v1141.md)
1818

1919
#### Other Resources

docs/framework/additional-apis/pos-for-net/linedisplay-implementation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ A **LineDisplay** Service Object is used to display text, bitmaps, and glyphs to
2121

2222
[Service Object Samples: Getting Started](service-object-samples-getting-started.md)
2323

24-
[Microsoft.PointOfService.BaseServiceObjects](ms843374\(v=winembedded.11\).md)
24+
<xref:Microsoft.PointOfService.BaseServiceObjects>

docs/framework/additional-apis/pos-for-net/linedisplay-sample.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ A **LineDisplay** Service Object may also monitor the device and report power or
1515

1616
1. Add **using** directives for the **Microsoft.PointOfService** and **Microsoft.PointOfService.BaseServiceObject** namespaces.
1717

18-
2. Add the global attribute [PosAssemblyAttribute](ms884816\(v=winembedded.11\).md) so that **PosExplorer** recognizes this as a Microsoft Point of Service for .NET (POS for .NET) assembly.
18+
2. Add the global attribute <xref:Microsoft.PointOfService.PosAssemblyAttribute> so that **PosExplorer** recognizes this as a Microsoft Point of Service for .NET (POS for .NET) assembly.
1919

2020
3. Create a new class which is derived from **LineDisplayBase**.
2121

22-
4. Add the class-level attribute [ServiceObjectAttribute](aa460884\(v=winembedded.11\).md) to your new class so that **PosExplorer** recognizes it as a Service Object.
22+
4. Add the class-level attribute <xref:Microsoft.PointOfService.ServiceObjectAttribute> to your new class so that **PosExplorer** recognizes it as a Service Object.
2323

2424
## To implement abstract LineDisplayBase members
2525

docs/framework/additional-apis/pos-for-net/pinpad-implementation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ A **PinPad** Service Object may also have the following additional capabilities:
2929

3030
## Reference
3131

32-
- [PinPadBase](aa460647\(v=winembedded.11\).md)
32+
- <xref:Microsoft.PointOfService.BaseServiceObjects.PinPadBase>
3333
Provides the Microsoft Point of Service for .NET (POS for .NET) reference for the **PinPadBase** class.
3434

3535
- [Developing a Custom Service Object](developing-a-custom-service-object.md)

0 commit comments

Comments
 (0)