GetBatchInfosForDefinition Method

Article
11/12/2009

Returns information about all batches in the specified definition.

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

Syntax

'Declaration
Public Function GetBatchInfosForDefinition ( _
    promoCodeDefinitionId As Integer, _
    onlyCompletedBatches As Boolean _
) As BatchInfo()

'Usage
Dim instance As PromoCodeDefinitionManager
Dim promoCodeDefinitionId As Integer
Dim onlyCompletedBatches As Boolean
Dim returnValue As BatchInfo()

returnValue = instance.GetBatchInfosForDefinition(promoCodeDefinitionId, _
    onlyCompletedBatches)

public BatchInfo[] GetBatchInfosForDefinition(
    int promoCodeDefinitionId,
    bool onlyCompletedBatches
)

public:
array<BatchInfo^>^ GetBatchInfosForDefinition(
    int promoCodeDefinitionId, 
    bool onlyCompletedBatches
)

public function GetBatchInfosForDefinition(
    promoCodeDefinitionId : int, 
    onlyCompletedBatches : boolean
) : BatchInfo[]

Parameters

promoCodeDefinitionId
Type: System..::.Int32
The Id of the PromoCodeDefinition definition for which the information is returned.

onlyCompletedBatches
Type: System..::.Boolean
true to return only batches that have been completed; otherwise false.

Return Value

Type: array<Microsoft.CommerceServer.Marketing..::.BatchInfo>[]()[]
An array of BatchInfo objects.

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

Returns an array of BatchInfo objects containing information about all batches in the specified definition.

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