Description complex type [SDM]

Article
03/22/2007

Platform SDK: System Definition Model Overview

Description Complex Type

Note: This documentation is preliminary and is subject to change.

Defines the elements that contain the information to describe an SDM element.

<xs:complexType name="Description"
    mixed="true"
>
    <xs:sequence>
        <xs:element name="Entry"
            type="DescriptionEntry"
            minOccurs="0"
            maxOccurs="unbounded"
         />
Entry

              The text of the description and the description entry.    </xs:sequence>
    <xs:attribute name="ResourceId"
        type="string"
        use="optional"
     />
ResourceId

            A resource identifier. To support localization of the description text, a resource identifier can be provided.    <xs:attribute name="Manager"
        type="QualifiedName"
        use="optional"
     />
Manager
The manager that contains the localized resources for the description.
          </xs:complexType>
 Description
  TBD

Child Elements

Element	Type	Description
Entry	DescriptionEntry	The text of the description and the description entry.

Attributes

Name	Type	Description
Manager	QualifiedName	The manager that contains the localized resources for the description.
ResourceId	string	A resource identifier. To support localization of the description text, a resource identifier can be provided.

Remarks

A description entry represents a single string that is used for display or error reporting. Each entry may have a resource identifier and manager name. These are used to retrieve localized versions of the string from the manager assembly’s satellite resource assemblies.

Example Code [XML]

The following example shows a description entry for a constraint. The error message substitutes several values from the constraint context into the message. The message will be retrieved from the SystemManager using the resource identifier “Findmember.FindHost.ErrorDescription” if the user interface culture does not match the .sdm file culture.

<Description>
   <Entry Name="ErrorDescription" 
        Substitute="InstanceName 
            Guest.InstanceName 
            FindGuestParent.Parent.InstanceName"
            Manager="SystemManager"
            ResourceId="FindMember.FindHost.ErrorDescription"
   >
   The hosting relationship {0} targets a host that is not within
   the allowed scope for this relationship. The host for
   instance {1} must be contained by the host for
   instance {2}.</Entry>
</Description>