SideShow Registry Settings (Windows CE 5.0)
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
10/16/2008
The registry stores information that is used to configure SideShow on the Windows Embedded CE powered device.
SideShow Service Settings
The registry subkeys for the SideShow service are stored in the HKEY_LOCAL_MACHINE\Services\SideShowService key.
The following table shows the values for this subkey, and the correct settings to enable the SideShow service:
| Value: type | Description |
|---|---|
Context : REG_DWORD |
Initial value passed into the initialization routine. Should be set to 0 (zero). |
Description : REG_SZ |
Description of display service. Should be set to "SideShow Service Provider". |
DisplayName : REG_SZ |
Display service name. Should be set to "SideShowService". |
Dll : REG_SZ |
Dynamic-link library (DLL) file to be loaded. Should be set to "SideShowService.dll". |
Index : REG_SZ |
Service index. Should be set to 0 (zero). |
Keep : REG_DWORD |
Should be set to 0 (zero), so that the dynamic-link library (DLL) will be unloaded immediately after initialization. |
MaxCacheSize : REG_DWORD |
Contains the maximum allowed size of the SideShow cache in bytes. This value is required. |
MaximumRetryWindow : REG_DWORD |
Contains the number of seconds to retry when a connection fails. This value is optional. If the registry entry is not present, the default is 30 minutes. |
Order : REG_DWORD |
Order in which Services.exe will load each service. The service with the lowest order is loaded first. Should be set to 10. |
Prefix : REG_SZ |
Prefix of the dynamic-link library (DLL). Should be set to "SSS". |
TransportDll : REG_SZ |
Contains the name of the dynamic-link library (DLL) to use as the active transport; for example, "SSTransport_IP.dll". This value is required. |
For more information about these values, see Services.exe Registry Settings.
Subkeys for the TCP/IP Transport
NOTIFY Messages for UPnP Discovery
The HKEY_LOCAL_MACHINE\SERVICE\SideShowService\SSDPRefreshNotifySec registry subkey specifies the amount of time between SSDP NOTIFY messages sent out as part of the UPnP discovery protocol. This subkey is used by the TCP/IP transport to announce that the device has become available on the network.
The following table shows the values for this subkey:
| Value: type | Description |
|---|---|
SSDPRefreshNotifySec : REG_DWORD |
Contains the number of seconds between SSDP NOTIFY messages. This value is optional. If this subkey is not present, the default is 300 seconds (5 minutes). |
For more information about the discovery protocol, see UPnP Discovery.
UPnP Device Configuration
The registry subkeys most relevant for SideShow UPnP device configuration are stored in the HKEY_LOCAL_MACHINE\COMM\UPnP key. These subkeys are used by the TCP/IP transport.
The following table shows the values for this subkey:
| Value: type | Description |
|---|---|
DiscoveryTimeToLive : REG_DWORD |
Specifies the maximum number of hops before the multicast message is discarded. This value is optional. |
DownloadScope : REG_DWORD |
This subkey applies to IPv4 only. It allows UPnP to verify URLs received from the network before making a request. This value is optional. By default, the device communicates with the desktop UPnP controller in the same subnet. |
IPVersionSetting : REG_DWORD |
Specifies the IP version to use. This value is optional. |
For more information about these registry settings, see UPnP Registry Settings.
Subkeys for the USB Transport
The registry subkeys for the USB transport are stored in the HKEY_LOCAL_MACHINE\Drivers\USB\FunctionDrivers\SideShowTransport_UsbFn key. Windows CE 5.0 does not provide the user interface (UI) needed to modify these registry settings.
The following table shows the values for this subkey:
| Value: type | Description |
|---|---|
idVendor : REG_DWORD |
The vendor ID. If you don't have a vendor ID, go to the USB Implementers Forum Web site to obtain one. |
Manufacturer : REG_SZ |
Name of the device manufacturer. The default is "Generic Manufacturer (PROTOTYPE)". |
idProduct : REG_DWORD |
Product ID. There is no default. You can set this value to whatever product ID you choose. |