LobSystem.MergeXml Method (String, String , PackageContents, AdministrationMetadataCatalog, String)

Reads the external system definition from the specified resource XML for the specified Metadata Store, and then merges its properties, localized names, and access control entries with the existing external system 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, _
    metadataCatalog As AdministrationMetadataCatalog, _
    settingId As String _
) As LobSystem
'Usage
Dim xml As String
Dim errors As String()
Dim packageContents As PackageContents
Dim metadataCatalog As AdministrationMetadataCatalog
Dim settingId As String
Dim returnValue As LobSystem

returnValue = LobSystem.MergeXml(xml, _
    errors, packageContents, metadataCatalog, _
    settingId)

public static LobSystem MergeXml(
    string xml,
    out string[] errors,
    PackageContents packageContents,
    AdministrationMetadataCatalog metadataCatalog,
    string settingId
)

Parameters

• xml
  Type: System.String

  The metadata.

• errors
  Type: []

  When this method returns, contains a list of noncritical errors that occurred when merging data or reading the XML. This parameter is passed uninitialized.

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

  Specifies which elements to read.

• metadataCatalog
  Type: Microsoft.SharePoint.BusinessData.Administration.AdministrationMetadataCatalog

  The Metadata Store in which the external system is defined.

• settingId
  Type: System.String

  The identifier (ID) of a partition in the Metadata Store in which to store properties, localized names, and access control entries; null indicates default settings.

Return Value

Type: Microsoft.SharePoint.BusinessData.Administration.LobSystem
The merged external system.

Exceptions

Exception	Condition
ArgumentNullException	xml or metadataCatalog is null .
ArgumentException	The value of the packageContents parameter is PackageContents.Model.
MetadataObjectNotFoundException	The external system does not exist in the specified Metadata Store.

Remarks

Use the packageContents parameter to specify which of the resources in the xml parameter to add to the Metadata Store.

If packageContents is PackageContents.Properties, BDC creates all the properties in xml in the specified setting. If a property with the same name exists, it is replaced by the new property. Merging properties requires “Edit” permissions in the specified setting.

If packageContents is PackageContents.LocalizedNames, BDC creates all the localized names in xml in the specified setting. If a localized name with the same LCID exists, it is replaced by the new localized name. Merging localized names requires “Edit” permissions in the specified setting.

If packageContents is PackageContents.Permissions, BDC replaces existing permissions with the new permissions in xml. Merging permissions requires the “SetPermissions” permission in the specified setting.

See Also

Reference

LobSystem Class

LobSystem Members

MergeXml Overload

Microsoft.SharePoint.BusinessData.Administration Namespace