Home > Articles > Programming > Visual Basic

Understanding Properties in Terms of AsyncRead

So, what are "properties" anyway? Well, in the case of using the AsyncRead method, they are a little different from what you are accustomed to with regard to programming a form in Visual Basic. Remember that the essence of asynchronous data retrieval is that distinct outgoing calls for particular pieces of data are made from the control, and that the data is returned in one continuous, mixed-up data stream. Figure 2 illustrates this point.

Figure 2: Identify each call to data on the Internet with a property name.

The trick to understanding properties when using the AsyncRead method is to conceptualize a property name as an identifier for each distinct data call. Thus, if you are using three AyncRead calls to retrieve three graphics from the Internet, you could assign each call a property name, such as PropPicOne, PropPicTwo, and PropPicThree, for example. If you were using AsyncRead to get text for a headline, you could assign the property name PropHeadLine to that data call. Remember that the property names are strings and must be enclosed in quotation marks when used in the AsyncRead method.

So now we know how to assign property names to data calls in the outgoing stream, but how do we use them to sort out data in the incoming stream? This is where the UserControl_AsyncReadProgress and UserControl_AsyncReadComplete events come into play.

Working with the UserControl_AsyncReadProgress Event

The UserControl object has smarts that allow it respond to incoming data generated from AysncRead method calls by firing events that are dependent on what's going on with a particular data transmission. Incoming data can be in one of two states — either it is in the process of being downloaded, or it is downloaded and cached on the client machine. When data is in the process of being downloaded, the UserControl fires one or many AsyncReadProgress events. It's sort of like saying, "Hey, I have some data coming in, and right now its status is that I am creating a name for the cache file into which I will store the data on the hard disk." Or, the UserControl might fire the AsyncReadProgress event and say, "Hey, I am connecting to the URL you have indicated." Every time a status event occurs, an AsyncReadProgress event is fired.

The UserControl_AsyncReadProgress event procedure captures the firing of the AsyncReadProgress event. You can program this event procedure to find out which status events are being fired for each data call to which you have associated a property name. The syntax of the UserControl_AsyncReadProgress is as follows:

Private Sub UserControl_AsyncReadProgress
(AsyncProp As AsyncProperty) End Sub

The AsyncProperty Object

Notice that the event procedure passes a parameter of type AsyncProperty. The AsyncProperty object encapsulates the data associated with a given data call invoked using the AsyncRead method. The AsyncProperty object contains the following properties:

  • AsyncType is the constant that indicates the type of data transfer (vbAsyncTypePicture, for example). You read about this earlier.

  • BytesMax is the estimated number of bytes to be downloaded during the transfer.

  • BytesRead is the number of bytes that have been read at the time the event was fired.

  • PropertyName is the name of the property.

  • Status is information that the UserControl wants to communicate to you. It is dependent on the value of the StatusCode property. For example, if the StatusCode is vbAsyncStatusCodeCacheFileNameAvailable, the value of the Status property will be a string that indicates the name of the cache file that was created to store the downloaded data.

  • StatusCode is a constant value that reports a particular status. For example, vbAsyncStatusCodeError indicates that an error has occurred during the download. (Refer to your copy of Visual Basic for complete listing of the StatusCode constants.)

  • Target indicates the URL from which the data was retrieved.

  • Value is the data of default property in force.

You query the different properties of the AsyncProperty object to maintain control over the various AsyncRead calls going on in your program. The following code snippet in Listing 1 shows the UserControl_AsyncReadProgress event procedure from the program I developed for this article. The code checks to see that file names have been created for incoming data. If they have, the file names are assigned to member variables for the custom control.

Listing 1: The AsyncReadProgress Event Procedure Monitors the State of Data in the Process of Asynchronous Download

Private Sub UserControl_AsyncReadProgress
(AsyncProp As AsyncProperty) 
'Check to see if a file name has been 
assigned to the StatusCode 
If AsyncProp.StatusCode = 
vbAsyncStatusCodeCacheFileNameAvailable Then 
   'Now check to make sure that the PropertyName for the 
  'AsyncProp object is the one for the poem data. 
   Select Case AsyncProp.PropertyName 
     Case PROP_POEM: 
      'If it is, get the name of the cache file 
      'that contains the poem data. 
      mPoemFileName = AsyncProp.Status 
     Case PROP_PIC: 
       mPicFileName = AsyncProp.Status 
     Case Else 
     'You fill in default behavior for other 
     'properties here 
   End Select 
End If
End Sub

Working with the UserControl_AsyncReadComplete Event

So where are we? Well, we've used the AsyncRead method to make two requests back to an Internet server. One request asks for some text data (a poem), and the other request asks for some graphic data (my company's attractive logo). We've programmed the UserControl_AsyncReadProgress event procedure to watch for file name assignments by the UserControl. These file names are assigned to member variables of the UserControl.

So when and how do we display the data? The mechanics of displaying data take place in the UserControl_AsyncReadComplete event procedure. This event procedure captures the firing of an AysncReadComplete event. AsyncReadComplete is fired when all the data made by a particular AysncRead method call is finished being downloaded. It's as if the UserControl is saying, "Hey, I've got all the data, now what?"

We implement data display in the Control_AsyncReadComplete event procedure in two ways. The first way is to display text to use the FileSystemObject to open the temporary cache file that contains the downloaded data, and then to assign the text within the file to a Textbox control. The second way is to use the LoadPicture function to display the data from the temporary graphics file. Let's look at how to use the FileSystemObject first.

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.


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.


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.


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.


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


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


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.


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.


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