Places a specified Category and all of the Tags it contains in a paused state, making them unavailable.

Namespace: Microsoft.Tag.CampaignManagement
Assembly: Microsoft.Tag.CampaignManagement (in Microsoft.Tag.CampaignManagement.dll) Version: 1.0.7785.0 (1.0.7785.0)

Syntax

C#
bool PauseCategory(
	UserCredential userCredential,
	string categoryName
)
Visual Basic
Function PauseCategory ( _
	userCredential As UserCredential, _
	categoryName As String _
) As Boolean
Visual C++
bool PauseCategory(
	UserCredential^ userCredential, 
	String^ categoryName
)

Parameters

userCredential
Type: Microsoft.Tag.CampaignManagement..::..UserCredential
A 64-bit encrypted GUID specifying the user credential.
categoryName
Type: System..::..String
The name of the category to be paused.

Return Value

true if the method succeeds

false if the method fails

Remarks

PauseCategory places the specified Category and all of the Tags it contains into a paused state, making them unavailable. A paused Category cannot be used until it has been reactivated with the ActivateCategory(UserCredential, String) method.

Examples

This code sample demonstrates how to call PauseCategory(UserCredential, String).
CopyC#
private void LocalPauseCategory()
{
    try
    {
        MIBPContractClient OMIBPClient = new MIBPContractClient();
        UserCredential oCredential = new UserCredential();

        oCredential.AccessToken = "Enter your access token";
        OMIBPClient.PauseCategory(oCredential, "Category Name");
    }
    catch
    {
        throw;
    }
}

See Also