Deactivate Method
Deactivate a CampaignItem.
Namespace: Microsoft.CommerceServer.Marketing
Assembly: Microsoft.CommerceServer.Marketing.CrossTierTypes (in Microsoft.CommerceServer.Marketing.CrossTierTypes.dll)
Syntax
'Declaration
Public Sub Deactivate ( _
campaignItemId As Integer _
)
'Usage
Dim instance As CampaignItemManager
Dim campaignItemId As Integer
instance.Deactivate(campaignItemId)
public void Deactivate(
int campaignItemId
)
public:
void Deactivate(
int campaignItemId
)
public function Deactivate(
campaignItemId : int
)
Parameters
- campaignItemId
Type: System..::.Int32
The identifier of the CampaignItem to be Deactivated.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | campaignItemId is less than or equal to zero. |
| EntityDoesNotExistException | campaignItemId refers to an entity that does not exist. |
| EntityStateException | campaignItemId refers to a campaign item that is deleted or already deactivated. |
Remarks
Deactivate is intended to be called by privileged users only. It can be used to immediately deactivate a CampaignItem without requiring the change to go through an approval process. Less privileged users can modify the Active property of a CampaignItem but generally are not given permission to use this method.
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.