Leadtools.Jpip Requires JPIP module product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
Encode Method
See Also 
Leadtools.Jpip.RequestEncoder Namespace > HttpRequestEncoder Class : Encode Method



fields
The RequestFields to be transmitted to the JPIP server.
path
A String value identifying the server URI.
postedData
An array of bytes to be sent in the request message body. This value can be null.
fields
The RequestFields to be transmitted to the JPIP server.
path
A String value identifying the server URI.
postedData
An array of bytes to be sent in the request message body. This value can be null.
Encodes JPIP parameters and creates a valid HttpWebRequest.

Syntax

Visual Basic (Declaration) 
Public Function Encode( _
   ByVal fields As RequestFields, _
   ByVal path As String, _
   ByVal postedData() As Byte _
) As HttpWebRequest
Visual Basic (Usage)Copy Code
Dim instance As HttpRequestEncoder
Dim fields As RequestFields
Dim path As String
Dim postedData() As Byte
Dim value As HttpWebRequest
 
value = instance.Encode(fields, path, postedData)
C# 
public HttpWebRequest Encode( 
   RequestFields fields,
   string path,
   byte[] postedData
)
C++/CLI 
public:
HttpWebRequest Encode( 
   RequestFields^ fields,
   String^ path,
   array<byte>^ postedData
) 

Parameters

fields
The RequestFields to be transmitted to the JPIP server.
path
A 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 HttpWebRequest ready to transmit the JPIP request to the server.

Example

For an example, refer to HttpRequestEncoder.

Remarks

If postedData is specified, the 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 HttpWebRequest will be created with a Get method with the fields encoded in the request URL.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Jpip requires a JPIP Module and a server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features