Message.RemoveFieldInstance

Method

Visual Basic

Public Sub RemoveFieldInstance(
    ByVal fieldName As String,
    ByVal instanceNumber As UInt32)

C#

public void RemoveFieldInstance(
    string  fieldName,
    uint    instanceNumber)

Purpose

Remove a specified instance of a field from a message.

Remarks

When a message contains several field instances with the same field name, remove a specific instance by number (for example, remove the ith field named foo). Programs can use this method in a loop that examines every field with a specified name.

The argument 1 denotes the first instance of the named field.

If the specified instance does not exist, the method throws an exception with the status code NotFound.

Parameter

Description
fieldName

Remove the field with this name.
instance

Remove this instance of the field. The argument 1 specifies the first instance of the named field.