←Select platform

Encode Method

Summary

Encodes JPIP parameters and creates a valid System.Net.HttpWebRequest.

Syntax

C#
VB
C++
public HttpWebRequest Encode( 
   RequestFields fields, 
   string path, 
   byte[] postedData 
) 
  
Public Function Encode( _ 
   ByVal fields As Leadtools.Jpip.RequestFields, _ 
   ByVal path As String, _ 
   ByVal postedData() As Byte _ 
) As HttpWebRequest 
public: 
HttpWebRequest^ Encode(  
   Leadtools.Jpip.RequestFields^ fields, 
   String^ path, 
   array<byte>^ postedData 
)  

Parameters

fields
The Leadtools.Jpip.RequestFields to be transmitted to the JPIP server.

path
A System.String value identifying the server URI.

postedData
An array of bytes to be sent in the request message body. This value can be null.

Return Value

An System.Net.HttpWebRequest ready to transmit the JPIP request to the server.

Remarks

If postedData is specified, the System.Net.HttpWebRequest will be created with a POST method and all fields will be encoded to the message body.

You can use the postedData parameter to optimize the process of encoding when sending cache information.

If postedData is null the System.Net.HttpWebRequest will be created with a Get method with the fields encoded in the request URL.

Example

For an example, refer to HttpRequestEncoder.

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Jpip Assembly