This topic has not yet been rated - Rate this topic

ComUdtElement Class

Represents a User Defined Type (UDT) that is to be included in the service contract. This class cannot be inherited.

System.Object
  System.Configuration.ConfigurationElement
    System.ServiceModel.Configuration.ComUdtElement

Namespace:  System.ServiceModel.Configuration
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public sealed class ComUdtElement : ConfigurationElement

The ComUdtElement type exposes the following members.

  Name Description
Public method ComUdtElement() Initializes a new instance of the ComUdtElement class.
Public method ComUdtElement(String) Initializes a new instance of the ComUdtElement class with the specified GUID string.
Top
  Name Description
Public property CurrentConfiguration Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public property ElementInformation Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected property ElementProperty Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected property EvaluationContext Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected property Item[ConfigurationProperty] Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected property Item[String] Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public property LockAllAttributesExcept Gets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public property LockAllElementsExcept Gets the collection of locked elements. (Inherited from ConfigurationElement.)
Public property LockAttributes Gets the collection of locked attributes (Inherited from ConfigurationElement.)
Public property LockElements Gets the collection of locked elements. (Inherited from ConfigurationElement.)
Public property LockItem Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public property Name Gets or sets the readable type name.
Protected property Properties Gets the collection of properties. (Inherited from ConfigurationElement.)
Public property TypeDefID Gets or sets a GUID string that identifies the specific UDT type within the registered type library.
Public property TypeLibID Gets or sets a GUID string that identifies the registered type library that defines the type.
Public property TypeLibVersion Gets or sets a string that identifies the type library version that defines the type.
Top
  Name Description
Protected method DeserializeElement Reads XML from the configuration file. (Inherited from ConfigurationElement.)
Public method Equals Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Protected method GetTransformedAssemblyString Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
Protected method GetTransformedTypeString Returns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Init Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected method InitializeDefault Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected method IsModified Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public method IsReadOnly Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected method ListErrors Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnDeserializeUnrecognizedAttribute Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected method OnDeserializeUnrecognizedElement Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected method OnRequiredPropertyNotFound Throws an exception when a required property is not found. (Inherited from ConfigurationElement.)
Protected method PostDeserialize Called after deserialization. (Inherited from ConfigurationElement.)
Protected method PreSerialize Called before serialization. (Inherited from ConfigurationElement.)
Protected method Reset Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected method ResetModified Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected method SerializeElement Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected method SerializeToXmlElement Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected method SetPropertyValue Sets a property to the specified value. (Inherited from ConfigurationElement.)
Protected method SetReadOnly Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method Unmerge Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The COM+ integration runtime creates services by inspecting the type library. When a COM+ component contains methods that pass a VARIANT, the system cannot determine the actual types to be passed prior to runtime. Therefore, when you attempt to pass a User Defined Type (UDT) within a VARIANT, it fails because it is not a known type for serialization.

To circumvent this problem, you can add the UDTs to the configuration file so that they can be included as known types on the appropriate service contract. In order to do so, you have to uniquely identify the UDT and the contract(s), that is, the original COM interface(s) that uses it.

The following example demonstrates adding two specific UDTs to the <userDefinedTypes> section of the configuration file for this purpose.


</services>
<!-- <comContracts> is under <system.ServiceModel> and at the same level-->
<!-- as <services> or <behaviors> -->
<comContracts>
  <comContract contract="{5163B1E7-F0CF-4B6A-9A02-4AB654F34284}"
    name="_Broker" namespace="http://tempuri.org/5163B1E7-F0CF-4B6A-9A02-4AB654F34284"
    requiresSession="true">
    <exposedMethods>
      <add exposedMethod="BuyStock" />
      <add exposedMethod="SellStock" />
      <add exposedMethod="ExecuteTransaction" />
    </exposedMethods>
    <userDefinedTypes>
      <userDefinedType name="CustomerType" typeLibID="{91DC728C-4F1A-45de-A9B6-B538E209CEA6}"
        typeLibVersion="1.0" typeDefID="{D129765C-F211-434e-825A-9A63198C41F2}" />
      <userDefinedType name="AddressType" typeLibID="{91DC728C-4F1A-45de-A9B6-B538E209CEA6}"
        typeLibVersion="1.0" typeDefID="{4616AE0D-687A-43B7-BC63-141AE3DFD099}" />
    </userDefinedTypes>
  </comContract>
</comContracts>

<behaviors>


The attributes of the <userDefinedType> element are defined as follows:

  • typeName : an optional attribute that provides the readable type name. This is not used by the runtime but helps a reader to distinguish the types.

  • typeLibID : a GUID string that specifies the registered type library that defines the type.

  • typeLibVersion : a string that specifies the type library version that defines the type.

  • typeDefID : a GUID string that specifies the specific UDT type within the registered type library.

When the service is initialized, the COM+ integration runtime looks up the specified types and adds them to the known types collection for the specified contracts.

The following example demonstrates adding two specific UDTs to the <userDefinedTypes> section of the configuration file for this purpose.


</services>
<!-- <comContracts> is under <system.ServiceModel> and at the same level-->
<!-- as <services> or <behaviors> -->
<comContracts>
  <comContract contract="{5163B1E7-F0CF-4B6A-9A02-4AB654F34284}"
    name="_Broker" namespace="http://tempuri.org/5163B1E7-F0CF-4B6A-9A02-4AB654F34284"
    requiresSession="true">
    <exposedMethods>
      <add exposedMethod="BuyStock" />
      <add exposedMethod="SellStock" />
      <add exposedMethod="ExecuteTransaction" />
    </exposedMethods>
    <userDefinedTypes>
      <userDefinedType name="CustomerType" typeLibID="{91DC728C-4F1A-45de-A9B6-B538E209CEA6}"
        typeLibVersion="1.0" typeDefID="{D129765C-F211-434e-825A-9A63198C41F2}" />
      <userDefinedType name="AddressType" typeLibID="{91DC728C-4F1A-45de-A9B6-B538E209CEA6}"
        typeLibVersion="1.0" typeDefID="{4616AE0D-687A-43B7-BC63-141AE3DFD099}" />
    </userDefinedTypes>
  </comContract>
</comContracts>

<behaviors>


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ