FilterDescriptor.MergeXml Method

Reads the FilterDescriptor definition from the specified resource XML for the specified method, and then merges its properties, localized names, and access control entries with the existing FilterDescriptor in the metadata store.

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

Syntax

'Declaration
Public Shared Function MergeXml ( _
    xml As String, _
    <OutAttribute> ByRef errors As String(), _
    packageContents As PackageContents, _
    method As Method, _
    settingId As String _
) As FilterDescriptor
'Usage
Dim xml As String
Dim errors As String()
Dim packageContents As PackageContents
Dim method As Method
Dim settingId As String
Dim returnValue As FilterDescriptor

returnValue = FilterDescriptor.MergeXml(xml, _
    errors, packageContents, method, _
    settingId)

public static FilterDescriptor MergeXml(
    string xml,
    out string[] errors,
    PackageContents packageContents,
    Method method,
    string settingId
)

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.

• method
  Type: Microsoft.SharePoint.BusinessData.Administration.Method

  The parent Method that the FilterDescriptor is defined in.

• settingId
  Type: System.String

  The identifier of a partition in the metadata store to store properties, localized names, and access control entries in; a null reference (Nothing in Visual Basic) indicates default settings.

Return Value

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

Exceptions

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

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

FilterDescriptor Class

FilterDescriptor Members

Microsoft.SharePoint.BusinessData.Administration Namespace