Action.MergeXml Method

  • Article

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

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

Syntax

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

returnValue = Action.MergeXml(xml, _
    errors, packageContents, entity, _
    settingId)

public static Action MergeXml(
    string xml,
    out string[] errors,
    PackageContents packageContents,
    Entity entity,
    string settingId
)

Parameters

  • errors
    Type: []

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

  • 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.Client.Action

The merged Action.

Exceptions

Exception Condition
ArgumentNullException

The xml or entity parameters are a null reference (Nothing in Visual Basic).
ArgumentException

The packageContents parameter has the PackageContents.Model value set.
MetadataObjectNotFoundException

The Action does not exist in the specified external content type.

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

Action Class

Action Members

Microsoft.SharePoint.BusinessData.Administration.Client Namespace