GetExportStatus Method

Article
11/12/2009

Gets the current status of a promotion code export operation.

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

Syntax

'Declaration
Public Function GetExportStatus ( _
    filePath As String _
) As PromoCodeOperationStatus

'Usage
Dim instance As PromoCodeDefinitionManager
Dim filePath As String
Dim returnValue As PromoCodeOperationStatus

returnValue = instance.GetExportStatus(filePath)

public PromoCodeOperationStatus GetExportStatus(
    string filePath
)

public:
PromoCodeOperationStatus^ GetExportStatus(
    String^ filePath
)

public function GetExportStatus(
    filePath : String
) : PromoCodeOperationStatus

Parameters

filePath
Type: System..::.String
The full path to the file to which promotion codes are being exported.

Return Value

Type: Microsoft.CommerceServer.Marketing..::.PromoCodeOperationStatus
A PromoCodeOperationStatus object describing the current status of the promotion code export operation.

Exceptions

Exception	Condition
EntityDoesNotExistException	No export has been recently performed for the file provided.

Remarks

When this method is called, it is possible for the PhaseComplete to incorrectly read 100% complete while there is still data to be exported. To ensure that the export has completed check the Status to be PromoCodeOperationStatusCode.Completed.

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