InitImportMailingList Method

Article
2009-11-12

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

This method is used to initialize import of users into a Simple Mailing List.

Namespace: Microsoft.CommerceServer.Marketing.WebService
Assembly: Microsoft.CommerceServer.Marketing.DataManagement (in Microsoft.CommerceServer.Marketing.DataManagement.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Overridable Function InitImportMailingList ( _
    listId As Guid, _
    filePath As String, _
    fileSize As Long, _
    fileLastWriteTime As DateTime _
) As UploadHandshake

'Usage
Dim instance As MarketingWebService
Dim listId As Guid
Dim filePath As String
Dim fileSize As Long
Dim fileLastWriteTime As DateTime
Dim returnValue As UploadHandshake

returnValue = instance.InitImportMailingList(listId, _
    filePath, fileSize, fileLastWriteTime)

[WebMethodAttribute]
public virtual UploadHandshake InitImportMailingList(
    Guid listId,
    string filePath,
    long fileSize,
    DateTime fileLastWriteTime
)

[WebMethodAttribute]
public:
virtual UploadHandshake^ InitImportMailingList(
    Guid listId, 
    String^ filePath, 
    long long fileSize, 
    DateTime fileLastWriteTime
)

public function InitImportMailingList(
    listId : Guid, 
    filePath : String, 
    fileSize : long, 
    fileLastWriteTime : DateTime
) : UploadHandshake

Parameters

listId
Type: System..::.Guid
The Id of the List into which users should be imported.

filePath
Type: System..::.String
Full path to the file that will be imported.

fileSize
Type: System..::.Int64
Size of the file that will be imported.

fileLastWriteTime
Type: System..::.DateTime
LastModified time of the file that will be imported.

Return Value

Type: Microsoft.CommerceServer..::.UploadHandshake
An UploadHandshake to indicate how the upload handshake should proceed.

Exceptions

Exception	Condition
InvalidCatalogOperationException	The specified list is locked. This means that this list is currently busy in another operation.
ArgumentNullException	The filePath or listId provided is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The filePath provided is not a valid absolute file path.
NotAuthorizedException	The calling user is not authorized to perform this operation.
UploadFileSizeException	The fileSize provided is larger than the configured maximum size allowed.
ListManagerException	An unspecified list exception.
ServerFaultException	An unexpected error occurred on the server.

Remarks

The file is uploaded to the server and the server will import the file into the database.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via