SPCopyDestinationCollection.Add Method

  • Article

Adds a copy destination that is represented by the specified URL, destination type, and comment to the collection of copy destination objects.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)> _
Public Function Add ( _
    url As String, _
    type As SPCopyDestinationType, _
    comment As String _
) As SPCopyDestination
'Usage
Dim instance As SPCopyDestinationCollection
Dim url As String
Dim type As SPCopyDestinationType
Dim comment As String
Dim returnValue As SPCopyDestination

returnValue = instance.Add(url, type, comment)

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)]
public SPCopyDestination Add(
    string url,
    SPCopyDestinationType type,
    string comment
)

Parameters

  • url
    Type: System.String

    A string that specifies the URL of the copy destination.

  • type
    Type: Microsoft.SharePoint.SPCopyDestinationType

    An SPCopyDestinationType value that indicates the copy behavior associated with the copy destination: "Ignore", "None", "No Update", or "Update". "Update" displays an update prompt on pages that display copy destinations with the update option checked. "No Update" displays the update prompt with the update option unchecked. "Ignore" does not display the update prompt." "None" does not set a type.

  • comment
    Type: System.String

    A string that specifies a comment associated with the copy destination.

Return Value

Type: Microsoft.SharePoint.SPCopyDestination

See Also

Reference

SPCopyDestinationCollection Class

SPCopyDestinationCollection Members

Microsoft.SharePoint Namespace