Element.SetChoice Method (String)

ElementSetChoice Method (String)

Note: This API is now obsolete.

Sets the named sub-element as the choice's selection. Deprecated, use SetChoice(Name) instead.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.2.1

Syntax

[ObsoleteAttribute("Deprecated, use SetChoice(Name) instead.")]
public abstract Element SetChoice(
	string name
)

<ObsoleteAttribute("Deprecated, use SetChoice(Name) instead.")>
Public MustOverride Function SetChoice ( 
	name As String
) As Element

public:
[ObsoleteAttribute(L"Deprecated, use SetChoice(Name) instead.")]
virtual Element^ SetChoice(
	String^ name
) abstract

[<ObsoleteAttribute("Deprecated, use SetChoice(Name) instead.")>]
abstract SetChoice : 
        name : string -> Element

Type: Element
The reference to the specified selection.

Exceptions

Exception	Condition
NotSupportedException	This element is not a choice or this element is read-only.
NotFoundException	The named sub-element cannot be found.

Remarks

Note that if this choice element already contains a selection it is discarded and the choice's selection is set to the named sub-element.