Objective

In this article, I will explain

1. How to work with collection in WCF?

2. How to work with concrete collection List<T> ?

3. How to work with interface IEnumerable<T> ?

4. How to convert Array at client side to collection

Collection at service side and client side


Since, COLLECTION is very much specific to .Net, so WCF does not expose it to the metadata of the service. But they are very useful, so WCF provides dedicated marshaling rules for collection.

Collection will be exposed as array in service metadata


Let us say, you are having a contract and service implementation as below, If you see carefully, I am returning a collection of the type student

IService1.cs

clip_image004

Service1.svc.cs

clip_image006

Now when you add this service reference at the client side, you can see the collection is exposed as array. To see this, add the service reference in a client.

I have created a console client and added the service reference of above service. When you click on ServiceReference1 in solution explorer, you can open the proxy code generated at the client side. So click on object browser and you can see that array has been returned in metadata instead of collection.

At the client side

clip_image008

Working with List<T<> or Concrete collection

Imagine a scenario, where return type is concrete collection not an interface. For example, we need to return List<T> instead if IEnumerable<T>

As we know from .Net 3.5 all the classes are by default serialized. And collection we are returning is marked with Serializable not with DataContract.

clip_image009

Signature of Add method should be,

clip_image010

Let us say,

Contract is,

IService1.cs

clip_image011

If you see above, we are returning List<Student> instead of IEnumerable<Student>. So again at the client side, List<Student> would be exposed as Student [] in service metadata.

Service implementation is as below,

Service1.svc.cs

clip_image015

And again after adding the service reference at the client side, you can see in the object browser List<Student> is exposed as Student[]

So, to call the service at the client side, we need to get the student in array of student

clip_image017

So if you see above code, I am taking the output of GetStudents() method in array of student(Student []).

If you want to avoid that, you do not want to use array but instead you want to get collection at the client side.

clip_image018

Follow the below steps,

Step 1

While adding the service reference click on Advanced option

clip_image019

Step 2

From the drop down of collection type tab, select System.Collections.Generic.List option.

clip_image020

Now at the client side,

clip_image022

Now you can see at the client side proxy is having list as return not array .

Conclusion

I hope this article was useful to you. Thanks for reading. Happy Coding .

Advertisements

2 thoughts on “Collection in WCF

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s