Skip to content

Description Meta-Tag

See Also: Object Member Meta-Data Tags

Purpose

Indicates the public description of the method.

Applies To

  • Properties

Syntax

{ Description={Value} }

Where {Value} is the "public" description of the method.

Use

This meta-data tag can be set to a value that will be used as the public description part of the exposed interface of a web application or web service.

This meta-data tag may only be applied to methods that reside in objects of classes cWebBusinessProcess or cWebService, or objects of subclasses of cWebBusinessProcess or cWebService.

This description is displayed in:

  • The .wso Web Service Test page, which is opened when you press F5 (Run) in the Studio when the focus is in a Web Service object (.wo) file. For example: http://localhost/WebOrder_19_1/TestService.wso
  • In the WSDL service description inside an XML node.

Example

This sample code shows how to associate a public description with a method declared in a web service object.

Object oMyWebService is a cWebService
    { Published = True }
    { Description = "Hello World function, returns Hello + name" }
    Function HelloWorld String sName returns String
        String sResult
        Move ("Hello, " + sName) to sResult
        Function_Return sResult
    End_Function
End_Object