Skip to main contentSkip to search
Powered by Zoomin Software. For more details please contactZoomin
Progress DocumentationProgress Documentation
Progress Documentation
  • Home
  • Home
  • EnglishČeštinaDeutsch (Germany)Español (Spain)FrançaisItaliano (Italy)Português (Brasil)日本語Русский (Russia)中文 (简体) (China)中文 (繁體, 台灣) (Taiwan)ar-AR
  • Login

.NET Open Clients

Sample .NET OpenAPI code

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
Table of Contents
  • Configure and Deploy .NET Open Client Applications
    • Select a .NET Open Client Runtime package
      • Support localized messages for .NET client interfaces
    • Prepare to generate proxies for a .NET client using ProxyGen or Batch ProxyGen
    • Build a .NET Open Client application using a .NET proxy
    • Deploy a .NET Open Client application using a .NET proxy
  • Proxy Objects and Methods
    • Proxy objects
      • Namespace for proxy objects
    • Proxy methods
      • Connection methods
      • Remote ABL methods
        • Pass parameters
        • Handle return values
      • Class factory methods
        • SubAppObject
        • ProcObject
      • Common properties
        • Connection ID
        • Procedure return string
        • Procedure type
        • Request ID
        • TLS subject name
      • Common methods
        • Cancel all requests
        • Dispose
    • Run methods on session-free AppObjects
      • Session-free threading model
      • Share the connection pool between session-free AppObjects
    • Sample proxy
      • Sample AppObject
      • Sample SubAppObject
      • Sample ProcObject
  • Connect to the application server
    • Establish the connection
      • Secure server connections to .NET Open Clients
    • Handle connection exceptions
    • Return a user defined string to the client from the application server connection procedure
    • Release a session-free Connection object
  • Data Type Mappings for Parameters
    • ABL data type mappings
      • Date and time conversions
      • Arrays as parameters
      • Pass arguments by reference
        • INPUT-OUTPUT parameters
        • OUTPUT parameters
      • Unknown value (?) as a parameter
        • Use .NET nullable value types
        • Set an INPUT or INPUT-OUTPUT parameter to the Unknown value (?)
        • Test an INPUT-OUTPUT or OUTPUT parameter for the Unknown value (?)
        • Use OpenEdge holder classes
        • Set an INPUT or INPUT-OUTPUT parameter to the Unknown value (?)
        • Test an INPUT-OUTPUT or OUTPUT parameter for the Unknown value (?)
    • ABL temp-table to ADO.NET DataTable mappings
      • Map temp-table components
      • Map temp-table component attributes
        • Temp-table and buffer attribute mappings
        • Buffer-field attribute mappings
      • Resolve differences between ABL and .NET date and time implementations
      • Map the XML-NODE-TYPE attribute to ADO.NET
    • ABL ProDataSet to ADO.NET DataSet mappings
      • Map ProDataSet components
      • Map ProDataSet component attributes
        • ProDataSet attribute mappings
        • Data-relation attribute mappings
    • PassTABLE and TABLE-HANDLE parameters
      • Static and dynamic temp-tables
      • Data type mapping for temp-table fields
      • Unknown value (?)
      • Temp-table array fields
      • Indexes for temp-tables
      • Pass a TABLE or TABLE-HANDLE as an INPUT parameter
      • Provide ABL extensions for INPUT TABLE-HANDLE parameters
      • Pass a TABLE or TABLE-HANDLE as an INPUT-OUTPUT parameter
      • Pass a TABLE or TABLE-HANDLE as an OUTPUT parameter
      • Temp-table examples
        • Sample static temp-table
        • Sample dynamic parameter
        • Sample .NET Open Client application using a temp-table
    • Pass DATASET and DATASET-HANDLE parameters
      • Static and dynamic ProDataSets
      • Data-type mapping for ProDataSets
      • Pass a DATASET or DATASET-HANDLE as an INPUT parameter
      • Provide ABL extensions for INPUT DATASET-HANDLE parameters
      • Pass a DATASET or DATASET-HANDLE as an INPUT-OUTPUT parameter
      • Pass a DATASET or DATASET-HANDLE as an OUTPUT parameter
      • Update a DataSet
      • ProDataSet examples
        • Sample static ProDataSet
        • Sample dynamic ProDataSet
        • Sample .NET Open Client application using a ProDataSet
        • Sample ProDataSet update
    • ProDataTable class methods
      • Array methods
        • GetArrayFieldName( )
        • IsExtentColumn( )
        • SetExtentColumns( )
      • Before-image methods
        • GetBImageFlag( )
        • SetBImageFlag( )
      • Column-related (buffer-field) methods
        • GetColumnProType( )
        • GetPosition( )
        • GetUserOrder( )
        • SetColumnProType( )
        • SetUserOrder( )
      • Error handling methods
        • GetErrorString( )
        • SetErrorString( )
      • Data source related methods
        • GetDataSourceModified( )
        • GetRejected( )
      • Schema marshaling methods
        • GetNoSchemaMarshal( )
        • SetNoSchemaMarshal( )
      • Transaction methods
        • GetUndo( )
    • ProDataSet class methods
      • Data source update-related methods
        • GetDataSourceModified( )
        • GetRejected( )
  • Access Proxy Properties
    • Application configuration file
    • RunTimeProperties and Connection classes
      • RunTimeProperties class
        • ServerName RunTime Property
      • Connection class
    • Access properties with methods
      • General property accessor methods for the RunTimeProperties class
        • Get property methods syntax
        • Set property methods syntax
        • Example
      • General property accessor methods for Connection objects
        • Get property methods syntax
        • Set property methods syntax
        • Example
      • Available properties
      • Access properties using purposed accessor methods
    • Access properties directly
      • Session properties
      • Thread control property
      • Proxy server specification properties
      • Transport Layer Security management properties
      • Tracing property (RunTimeProperties only)
        • Compression property
    • Relationship between RunTimeProperties and Connection objects
    • Modify an instantiated Connection object's properties
    • Alphabetical listing of properties
      • PROGRESS.Session.ClientContextID
      • PROGRESS.Session.EnableCompression
      • PROGRESS.Session.CompressionLevel
      • PROGRESS.Session.CompressionThreshold
      • PROGRESS.Session.ConnectionLifetime
      • PROGRESS.Session.ConnectionTimeout
      • PROGRESS.Session.EnableTracing
      • PROGRESS.Session.HttpTimeout
      • PROGRESS.Session.IdleConnectionTimeout
      • PROGRESS.Session.InitialConnections
      • PROGRESS.Session.LogFileName
      • PROGRESS.Session.LoggingLevel
      • PROGRESS.Session.LoggingEntryType
      • PROGRESS.Session.MaxConnections
      • PROGRESS.Session.MinConnections
      • PROGRESS.Session.NoHostVerify
      • PROGRESS.Session.NoSchemaMarshal
      • PROGRESS.Session.NsClientMaxPort
      • PROGRESS.Session.NsClientMinPort
      • PROGRESS.Session.NsClientPicklistExpiration
      • PROGRESS.Session.NsClientPicklistSize
      • PROGRESS.Session.NsClientPortRetry
      • PROGRESS.Session.NsClientPortRetryInterval
      • PROGRESS.Session.ProxyHost
      • PROGRESS.Session.ProxyPassword
      • PROGRESS.Session.ProxyPort
      • PROGRESS.Session.ProxyUserId
      • PROGRESS.Session.RequestWaitTimeout
      • PROGRESS.Session.SessionModel
      • PROGRESS.Session.TcpKeepAliveInterval
      • PROGRESS.Session.TcpKeepAliveTime
      • PROGRESS.Session.TcpMaxDataRetranmission
      • PROGRESS.Session.WaitIfBusy
  • Handle Errors
    • General ABL exceptions
      • Exception class hierarchy
      • Exception descriptions
  • Use OpenEdge .NET Proxy Objects in Microsoft Visual Studio
    • Types of .NET open clients
      • Windows forms (GUI)
      • Web forms (ASP.NET)
      • .NET Web services (ASP Web services)
    • Get started building a .NET Open Client application using Microsoft Visual Studio
  • Use the Open Client .NET OpenAPI to Directly Access the application server
    • Overview of .NET OpenAPI classes and enumerations
    • Connect to the application server with .NET Open Client APIs
    • Run procedures and user-defined functions
      • Return the validity of the server session on an OpenAppObject
      • Run a non-persistent procedure on an OpenAppObject
      • Run a persistent procedure (OpenProcObject) on an OpenAppObject
      • Run a single-run or singleton procedure (OpenProcObject) on an OpenAppObject
      • Run an internal procedure or user-defined function on an OpenProcObject
    • Set up parameters and return types
      • Create variables for parameters
      • Set up a parameter array
        • Create a parameter array
      • Set the input and output error reset policy for the parameter array
      • Add parameters using data type-specific methods
        • General syntax for add parameter methods
        • Syntax summaries of all data type-specific add parameter methods
        • CHARACTER
        • COM-HANDLE
        • DATASET and DATASET-HANDLE
        • DATE
        • DATETIME
        • DATETIME-TZ
        • DECIMAL
        • HANDLE
        • INT64
        • INTEGER
        • LOGICAL
        • LONGCHAR
        • MEMPTR
        • RAW
        • RECID
        • ROWID
        • TABLE and TABLE-HANDLE
      • Add parameters using a generic method
      • Define the schema for a temp-table parameter
        • Define a TempTableMetaData object
        • Add field descriptions to the TempTableMetaData object
        • Add the TempTableMetaData with its DataTable as a temp-table parameter
      • Define the schema for a ProDataSet parameter
        • Define a ProDataSetMetaData object
        • Define the temp-tables for the ProDataSetMetaData object
        • Define the data-relations for the ProDataSetMetaData object
        • Add the ProDataSetMetaData object with its DataSet as a ProDataSet parameter
      • Define the return type for a user-defined function
        • ReturnType property
        • IsReturnExtent property
        • UnknownReturnType property
        • IsReturnUnknown property
    • Pass parameters
      • Pass INPUT parameters
      • Pass INTPUT-OUTPUT parameters
      • Pass OUTPUT parameters
    • Handle returned values
      • Get OUTPUT parameter values
      • Access RETURN-VALUE function output from procedures
      • Access user-defined function return values
    • Sample .NET OpenAPI code
      • Non-persistent procedure sample
      • Persistent procedure sample
      • Single-run/singleton procedure example
      • Pass DATASET and TABLE parameters example
      • Pass DATASET-HANDLE and TABLE-HANDLE parameters example
Table of Contents

Sample .NET OpenAPI code

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: January 16, 2024
  • 1 minute read
    • OpenEdge
    • Version 12.8
    • Documentation

Sample .NET OpenAPI code

The following sections describe two types of sample code:

  • Non-persistent procedure sample
  • Persistent procedure sample
  • Single-run/singleton procedure example
Note: These samples are not available for download on the Progress Communities Web site.
Contents
  • Non-persistent procedure sample
  • Persistent procedure sample
  • Single-run/singleton procedure example
  • Pass DATASET and TABLE parameters example
  • Pass DATASET-HANDLE and TABLE-HANDLE parameters example
TitleResults for “How to create a CRG?”Also Available inAlert