TypeDescriptor.MergeXml method (String, String[], PackageContents, Parameter, TypeDescriptor)

NOTE: This API is now obsolete.

Reads the TypeDescriptor definition from the specified resource XML for the specified parent type descriptor object, and then merges its properties, localized names, and access control entries with the existing TypeDescriptor in the metadata store.

Namespace:  Microsoft.SharePoint.BusinessData.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<ObsoleteAttribute("Use overload with settingId")> _
Public Shared Function MergeXml ( _
    xml As String, _
    <OutAttribute> ByRef errors As String(), _
    packageContents As PackageContents, _
    parameter As Parameter, _
    parent As TypeDescriptor _
) As TypeDescriptor
'Usage
Dim xml As String
Dim errors As String()
Dim packageContents As PackageContents
Dim parameter As Parameter
Dim parent As TypeDescriptor
Dim returnValue As TypeDescriptor

returnValue = TypeDescriptor.MergeXml(xml, _
    errors, packageContents, parameter, _
    parent)

[ObsoleteAttribute("Use overload with settingId")]
public static TypeDescriptor MergeXml(
    string xml,
    out string[] errors,
    PackageContents packageContents,
    Parameter parameter,
    TypeDescriptor parent
)

Parameters

• xml
  Type: System.String

  A string containing the metadata XML.

• errors
  Type: []

  A list of noncritical errors that occurred when merging data or reading the XML.

• packageContents
  Type: Microsoft.SharePoint.BusinessData.Parser.PackageContents

  Options that specify which elements to read.

• parameter
  Type: Microsoft.SharePoint.BusinessData.Administration.Parameter

  The parent parameter in which the TypeDescriptor is defined.

• parent
  Type: Microsoft.SharePoint.BusinessData.Administration.TypeDescriptor

  The parent type descriptor in which the TypeDescriptor is defined.

Return value

Type: Microsoft.SharePoint.BusinessData.Administration.TypeDescriptor
The merged TypeDescriptor.

Exceptions

Exception	Condition
ArgumentNullException	The xml or the parameter parameter is a null reference (Nothing in Visual Basic).
ArgumentException	The packageContents parameter has the PackageContents.Model value set.
MetadataObjectNotFoundException	The TypeDescriptor does not exist in the specified parent type descriptor.

Remarks

This method allows you to specify which resources that are present in the given metadata XML string are to be added to the metadata store via the packageContents parameter.

If the PackageContents.Properties value is specified in the packageContents parameter, BDC will create all the properties in the given XML in the specified setting. If a property with the same name exists, it will be replaced by the new property. Merging properties requires “Edit” permissions in the specified setting.

If PackageContents.LocalizedNames value is specified in the packageContents parameter, BDC will create all the localized names in the given XML in the specified setting. If a localized name with the same LCID exists, it will be replaced by the new localized name. Merging localized names requires “Edit” permissions in the specified setting.

If PackageContents.Permissions value is specified in the packageContents, BDC will replace existing permissions with the new permissions in the given XML. Merging permissions requires the “SetPermissions” permission in the specified setting.

See also

Reference

TypeDescriptor class

TypeDescriptor members

MergeXml overload

Microsoft.SharePoint.BusinessData.Administration namespace