StreamLink.NET
CreateRecordSubscriptionParameters Method (fields)
StreamLink.NETCaplin.StreamLinkIParametersFactoryCreateRecordSubscriptionParameters(array<String>[]()[])
Creates parameters for a record subscription, defining which fields will be requested.
Declaration Syntax
C#Visual BasicVisual C++
IRecordSubscriptionParameters CreateRecordSubscriptionParameters(
	string[] fields
)
Function CreateRecordSubscriptionParameters ( _
	fields As String() _
) As IRecordSubscriptionParameters
IRecordSubscriptionParameters^ CreateRecordSubscriptionParameters(
	array<String^>^ fields
)
Parameters
fields (array< String >[]()[])
The record fields to subscribe to.
Return Value
The parameters required to make a record subscription (see Remarks).
Remarks
When a subscription is made using the returned IRecordSubscriptionParameters, only the record fields specified in the IRecordSubscriptionParameters are subscribed to. When the record is subsequently updated on the Liberator the application is supplied with updates to just the subscribed fields.
Examples
CopyC#
using System;
using System.Collections.Generic;
using System.Text;
using Caplin.StreamLink;
using Caplin.StreamLink.Authentication;
using Caplin.StreamLink.Subscription.Record;

namespace StreamLinkExamples.Record
{
    /// <summary>
    /// Various examples of how to create an IRecordSubscription using the
    /// IStreamLinkProvider interface.
    /// </summary>
    public class CreateRecordSubscriptionWithFields
    {
        /// <summary>
        /// Creates a simple record subscription with no parameters.
        /// </summary>
        public static void CreateRecordSubscriptionWithFieldsExample()
        {
            // Set up StreamLink and login credentials
            IStreamLink myStreamLink = new StreamLink();
            myStreamLink.CredentialsProvider =
                new PasswordCredentialsProvider("admin", "admin");

            // Set up listener and created the subscription for /DEMO/MSFT
            IRecordSubscriptionListener listener =
                new ExampleRecordSubscriptionListener();

            string[] fields = new string[] { "Bid", "Ask" };
            IRecordSubscriptionParameters parameters = myStreamLink.StreamLinkProvider.ParametersFactory.CreateRecordSubscriptionParameters(fields);

            // Create subscription, specifying fields Bid and Ask
            IRecordSubscription subscription =
                myStreamLink.StreamLinkProvider.CreateRecordSubscription(listener, "/DEMO/MSFT", parameters);

            // Subscribe the subscription, this will be queued until we
            // login to the Liberator
            subscription.Subscribe();

            // Finally, connect to the Liberator
            myStreamLink.StreamLinkProvider.Connect();
        }
    }
}

Assembly: Caplin.StreamLink (Module: Caplin.StreamLink) Version: 5.0.19.0 (5.0.19.0)