Home > Articles > Web Services

  • Print
  • + Share This
This chapter is from the book

Passing Arguments

Often, it is necessary to do more than simply have your methods return data to a user request. Oftentimes, you will require some information from them in order to perform your tasks. This is where parameters come in. Parameters define the types of information that you are requesting from a client.

XML Web services accept all primitive data types as parameters. The syntax for declaring your parameters is exactly the same as it is in function calls in non XML Web service programming. That is to say, it takes the following form:

<Webmethod()> Public Function FuntionName (ByVal/byRef paramName as Type) as type

Or in C#

Public type FunctionName(type paramName)

byVal and byRef denote the way in which incoming variables are treated. For now, we will be using only byVal, which accepts a copy of the data and leaves the original unchanged. In later examples, we will want to change the original variables, and byRef will be used.

If you need to use multiple parameters, they must be separated by a comma.

Listing 10.13 shows an XML Web service method that accepts two strings as its parameters, concatenates them with the word "and" in between them, and returns the resulting string.

Listing 10.13 Primitive Data Type Parameters in VB

1:  <WebMethod()> Public Function ParamStringReturn( _
2:    ByVal sWord1 As String, ByVal sWord2 As String) As String
3:
4:    Return sWord1 & " and " & sWord2
5:
6:  End Function

The C# declaration for that same example is as follows:

public string ParamStringReturn(string sWord1, string sWord2)

To call the above function, a client application could now use the following syntax:

SVar = Service.ParamStringReturn("HITHER", "THITHER")

In the above, sVar is a string variable for the return value and Service is the object reference to your XML Web service.

You can also accept more complicated types, such as enumerations, as parameters in your code. Listing 10.14 shows a new enumeration in Visual Basic.

Listing 10.14 Enumeration Called Champion in VB

1:  Public Enum Champion
2:    Corum = 1
3:    Renark = 2
4:    Urlich = 3
5:    Hawkmoon = 4
6:  End Enum

Now we can accept this enumeration in code in exactly the same way as we did the previous primitive types. Listing 10.15 shows a method that will accept a variable of type Champion.

Listing 10.15 Passing Enumerations into VB

1:  <WebMethod()> Public Function ParamEnumReturn( _
2:      ByVal enumName As Champion) As champion
3:
4:     Return enumName
5:
6:  End Function

The C# code for declaring the function would be

public Champion ParamEnumReturn(Champion enumName )

XML Web services allow us to accept variable sized arrays as parameters in our code. To do so, you would simply declare parameters as such:

ByVal/byRef paramName() as Type

Listing 10.16 demonstrates the Visual Basic method of accepting an array of integers, iName, as a parameter. This method then returns an integer—in this case the number of elements in the array.

Listing 10.16 Accepting Arrays as Parameters in VB

1:  <WebMethod()> Public Function ParamArrayReturn( _
2:     ByVal iName() As Integer) As Integer
3:
4:    Return UBound(iName)
5:
6:  End Function

Listing 10.17 shows the C# method for accepting an array as a parameter. It also returns the number of elements in the array by using the GetUpperBound method. The ability to retrieve the number of elements in an array is crucial to working with them.

Listing 10.17 Accepting Arrays as Parameters in C#

1:  [WebMethod]
2:  public int ParamArrayReturn( int[] iName )
3:   {	
4:   return iName.GetUpperBound(0);
5:   }	

Passing Arguments by Reference

Up until now, all the examples that you have seen have passed values in byVal. Using byVal, a copy of the variable is sent to the method and the original data is left unchanged. In this section, we will look at byRef. Using byRef, or ref in C#, a reference to the original variable is used and any alterations that the method does to its parameters are also done to the original variable in the calling program.

If you have been adding the previous methods into your DataTypes XML Web service, continue doing so with the following examples. If you haven't, you may wish to start, as you will soon be building a small client application to demonstrate how the following methods change the value of variables on the client.

Add Listing 10.18 to your service. This method accepts an integer as its parameter and then decrements it by one. It also saves a copy of the original value to pass back as its return value.

Listing 10.18 Passing a Primitive Data Type byRef Parameters in VB

1:  <WebMethod()> Public Function RefReturn ( _
2:		ByRef iVal As Integer) As Integer
3:
4:   Dim iOld As Integer
5:
6:   iOld = iVal
7:   iVal = iVal - 1
8:
9:   Return iOld
10: End Function

If you are using C#, you will have to build your method using the following declaration:

public int RefReturn(ref int iVal)

After you have added the refReturn method, go back and make sure that you have the declaration for the Person class, Listing 10.7 (Listing 10.8 for C#), in your code. You will be using this class shortly.

Now, add listing 10.19 to your service. This new method will accept a Person object as a parameter and change its values.

Listing 10.19 Accepting an Object as a Parameter in VB

1:  <WebMethod()> Public Sub refClassReturn(ByRef oPers As Person)
2:
3:   oPers.ID = oPers.ID - 1
4:   oPers.Name = "Hi " & oPers.Name
5:
6:  End Sub

For those following along in C#, declare your refClassReturn with the following line:

public void refClassReturn(ref Person oPers)

Now, save and build the project. At this point, you will begin work on a simple client application that will call your XML Web service and display the return values.

Create a new Windows application and add a Web reference to your DataType XML Web service. See Hour 8 if you need a reminder on how this is done.

Next, create a form that looks like the one shown in Figure 10.5. For simplicity's sake, leave the default names for all of the controls.

Figure 10.5 The form for your byRef client application.

Now, add the following line to your general declarations:

Dim oData As New localhost.Service1()

This will create the object reference to your DataType XML Web service.

Now, add listing 10.20 to the button click event of Button1. This code will take the integer value typed into TextBox1 and store it to a variable called iVal. iVal is then passed to the RefReturn method and the return value is displayed in TextBox2. The new value of iVal is displayed in TextBox3.

Listing 10.20 Passing a Primitive Data Type by Reference

1:  Protected Sub Button1_Click(ByVal sender As System.Object,_
2:      ByVal e As System.EventArgs) Handles Button1.Click
3:
4:   Dim iVal As Integer
5:
6:   iVal = CInt(TextBox1.Text)
7:
8:   textbox3.text = CStr(oData.RefReturn (iVal))
9:
10:   Textbox2.Text = CStr(iVal)
11:
12:  End Sub

Figure 10.6 shows the end result of clicking Button1. Notice that the value of iVal, labeled "Old Value," is now decremented by one.

Figure 10.6 Returning values from your refReturn method.

Listing 10.21 shows the code that you should now add to the Click event of Button2. This code will take the values in TextBox4 and TextBox5 and store them into the Name and Id properties of our oPerson object. oPerson is then passed, byRef, to the refClassReturn method and the value refreshed to its respective textboxes.

Listing 10.21 Passing an Object as a Parameter

1:  Public Sub Button2_Click(ByVal sender As Object,_
2:    ByVal e As System.EventArgs) Handles Button2.Click
3:
4:   Dim oPerson As New localhost.Person()
5:
6:   oPerson.Name = textbox4.Text
7:   oPerson.ID = Cint(Textbox5.Text)
8:
9:   odata.refClassReturn(oPerson)
10:
11:   Textbox4.Text = oPerson.Name
12:   Textbox5.Text = CStr(operson.ID)
13:  End Sub

Figure 10.7 shows the results of passing the Name "Danielle" and ID "6" to the refClassReturn method.

Figure 10.7 Returning an array of objects of type Person.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020