Implementation Block (Windows CE 5.0)

Send Feedback

An implementation block defines an instance of a component type. The implementation block exists within the scope of a ComponentType block.

A component type can have multiple implementation blocks.

A ComponentType block is not required to have an implementation block. There is no limit to the number of implementation blocks that a ComponentType block can have.

The following code example shows a ComponentType block with an implementation block.

ComponentType(
  Name( MyGWESCatalogItem )
  GUID( <GUID Value> ) 
  Description( "This is the GWES functionality" )
  Implementations(
    Implementation(
        Name( MyComp )
        GUID( <GUID Value> )
        Children( <GUID Value> )
        Children( <GUID Value> )
    )
  )
)

The following table shows the elements of implementation block subblocks.

Element Description
Name Identifies the name of this specific implementation.
GUID (Optional) Supplies the GUID.

If the GUID is not present, it is created when the implementation is imported.

The default is none.

Description (Optional) Describes this Catalog item implementation.

The description must be enclosed in quotation marks.

Version Specifies the version of this Catalog item, using the following format:
Version( <major version>.<minor version>.<build number>.<update number>)

For items imported with a later version number than an existing item, the new item replaces the existing one.

If the existing item has a later version number, Platform Builder rejects the new item.

Locale Specifies the locale of the Catalog item, using the following format.

Locale( 0409 )

Vendor (Optional) Specifies the vendor for this implementation.

The default is none.

Date (Optional) Specifies the implementation date.

The format is mm/dd/yy.

SizeIsCPUDependent (Optional) Specifies whether the size of the Catalog item is CPU-specific.

If the size of the Catalog item is dependent on a specific CPU, set to "1".

For example, code compiled for a MIPS CPU typically requires more space than code compiled for an x86 CPU. If a Catalog item is mainly composed of code, it has a SizeIsCPUDependent setting of "1". Otherwise, if the item consists mainly of data, SizeIsCPUDependent is set to "0".

Platform Builder uses SizeIsCPUDependent and ImplSize to estimate the total size of the run-time image.

Children (Optional) Lists child component types by name or GUID.

The default is none.

You do not need to include quotation marks for a list of children.

Children are pulled into the OS design when a parent is added, and parent Catalog items are added to an OS design when a child is added.

OptionalChildren (Optional) Specifies children that contribute to this implementation but are not required for this implementation.

An optional child Catalog item is not pulled into the OS design when a parent is added. It must be added manually.

Parent Catalog items are added to an OS design when an optional child is added.

BuildMethods Element that specifies supported microprocessors and associated source files.
ExcludeWhenSet (Optional) Lists a set of variables that, when set in the OS design, cause this implementation to be excluded from the build.
Note   In Windows CE 5.0, this setting is ignored.
HelpID (Optional) Contains the help identifier used for ComponentType lookup in the Platform Builder Help system.
FeatureVariable (Optional) Contains the variable that associates this implementation with a Catalog item.

The parameter set by this element is the Sysgen variable used by the build system.

Note   In Windows CE 5.0, if you set value to "" or leave it blank, the entire declaration is ignored. If you use any other values as the setting for value, Platform Builder sets value to "1".
ImplSize (Optional) Contains the physical size of memory that this Catalog item adds to the run-time image.

Platform Builder uses SizeIsCPUDependent and ImplSize to estimate the total size of the run-time image.

BSPPlatformDir (Optional) Lists the BSP directory that this implementation is associated with.

When set, this variable causes this implementation to be shown in the catalog under all BSPs that have the same BSP directory as the BSPPlatformDir variable.

Variable (Optional) Specifies environment variables associated with this Catalog item, using the following format:

Variable( <variable name>, <value> )

Note   In Windows CE 5.0, if you set value to "" or leave it blank, the entire declaration is ignored. If you use any other values as the setting for value, Platform Builder sets value to "1".
DefaultDrivers Specifies the default drivers to use for this Catalog item, using the following format:
DefaultDrivers( <Implementation GUID (of a driver)> )

Only BSPs should use this element.

Note   In Windows CE 5.0, this setting is deprecated. To set the default drivers for your BSP, modify the associated Platform.bat file. For example, to set default drivers for a BSP called MyBSP, modify the file %_WINCEROOT%\Platform\MyBSP\MyBSP.bat.

See Also

Catalog Item Files | Catalog Item Migration

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.