Places a specified Tag in a paused state, making it 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 PauseTag(
	UserCredential userCredential,
	string categoryName,
	string tagName
)
Visual Basic
Function PauseTag ( _
	userCredential As UserCredential, _
	categoryName As String, _
	tagName As String _
) As Boolean
Visual C++
bool PauseTag(
	UserCredential^ userCredential, 
	String^ categoryName, 
	String^ tagName
)

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 containing the Tag to be paused.
tagName
Type: System..::..String
The name of the Tag to be paused.

Return Value

true if the method succeeds

false if the method fails

Remarks

The PauseTag method places a specified Tag in a paused state, making it unavailable. A paused Tag cannot be used until it has been reactivated with the ActivateTag(UserCredential, String, String) method.

PauseTag fails when any of the following invalid parameters is passed:

  • Category not found.
  • Category is paused.
  • Tag not found.

Examples

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

        oCredential.AccessToken = "Enter your access token";

        OMIBPClient.PauseTag(oCredential, "Category Name", "Tag Title");

    }
    catch
    {
        throw;
    }
}

See Also