BeginExportPromoCodesForDefinition Method (String, Int32, Guid, PromoCodeDefinitionManager.ProgressEventHandler, AsyncCallback, Object)

Article
11/12/2009

Asynchronously saves all promocodes in a given definition and batch to a file.

Namespace: Microsoft.CommerceServer.Marketing
Assembly: Microsoft.CommerceServer.Marketing.CrossTierTypes (in Microsoft.CommerceServer.Marketing.CrossTierTypes.dll)

Syntax

'Declaration
Public Function BeginExportPromoCodesForDefinition ( _
    filePath As String, _
    promoCodeDefinitionId As Integer, _
    batchId As Guid, _
    eventHandler As PromoCodeDefinitionManager..::.ProgressEventHandler, _
    callback As AsyncCallback, _
    asyncState As Object _
) As IAsyncResult

'Usage
Dim instance As PromoCodeDefinitionManager
Dim filePath As String
Dim promoCodeDefinitionId As Integer
Dim batchId As Guid
Dim eventHandler As PromoCodeDefinitionManager..::.ProgressEventHandler
Dim callback As AsyncCallback
Dim asyncState As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginExportPromoCodesForDefinition(filePath, _
    promoCodeDefinitionId, batchId, _
    eventHandler, callback, asyncState)

public IAsyncResult BeginExportPromoCodesForDefinition(
    string filePath,
    int promoCodeDefinitionId,
    Guid batchId,
    PromoCodeDefinitionManager..::.ProgressEventHandler eventHandler,
    AsyncCallback callback,
    Object asyncState
)

public:
IAsyncResult^ BeginExportPromoCodesForDefinition(
    String^ filePath, 
    int promoCodeDefinitionId, 
    Guid batchId, 
    PromoCodeDefinitionManager..::.ProgressEventHandler^ eventHandler, 
    AsyncCallback^ callback, 
    Object^ asyncState
)

public function BeginExportPromoCodesForDefinition(
    filePath : String, 
    promoCodeDefinitionId : int, 
    batchId : Guid, 
    eventHandler : PromoCodeDefinitionManager..::.ProgressEventHandler, 
    callback : AsyncCallback, 
    asyncState : Object
) : IAsyncResult

Parameters

filePath
Type: System..::.String
Full path to the file to which the promotion codes will be exported.

promoCodeDefinitionId
Type: System..::.Int32
Id of the PromoCodeDefinition that contains the batch specified by batchId.

batchId
Type: System..::.Guid
Id of the specific batch whose promotion codes will be exported.

eventHandler
Type: Microsoft.CommerceServer.Marketing..::.PromoCodeDefinitionManager..::.ProgressEventHandler
The PromoCodeDefinitionManager..::.ProgressEventHandler delegate instance called regularly for progress notification.

callback
Type: System..::.AsyncCallback
The delegate to call when the asynchronous invoke is completed. If callback is nullNothingnullptra null reference (Nothing in Visual Basic), the delegate is not called.

asyncState
Type: System..::.Object
Context data passed to the callback delegate.

Return Value

Type: System..::.IAsyncResult
An IAsyncResult object representing the status of the asynchronous operation.

Exceptions

Exception	Condition
NotAuthorizedException	The user is not authorized to perform this operation.
ArgumentOutOfRangeException	The promoCodeDefinitionId argument value is less than or equal to zero.
EntityDoesNotExistException	A PromoCodeDefinition object with such promoCodeDefinitionId does not exist.

Remarks

The proxy class calls the BeginInvoke method to start an asynchronous invocation call to the XML Web service method. The returned IAsyncResult represents the status of an asynchronous operation and is passed to EndExportPromoCodes to obtain the return values from the remote method call.

eventHandler may be nullNothingnullptra null reference (Nothing in Visual Basic) if the caller does not wish to receive progress notifications.

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