vm_https_set

Syntax

VM_RESULT vm_https_set_channel(
    VMUINT16 request_id, 
    VMBOOL use_proxy, 
    VMUINT8 proxy_ip[4], 
    VMUINT16 proxy_port, 
    VMSTR username, 
    VMUINT8 username_length, 
    VMSTR password, 
    VMUINT8 password_length, 
    VMSTR server_authorize_username, 
    VMUINT8 server_authorize_username_length, 
    VMSTR server_authorize_password, 
    VMUINT8 server_authorize_password_length, 
    VMSTR static_header, 
    VMUINT32 static_header_length
);

Description

Configure a dedicated channel for HTTP/WSP requests. An channel can be configured to use a proxy while use_proxy is true. When use_proxy is true, This function configures a dedicated channel for HTTP/WSP requests. A channel can be configured to use a proxy while use_proxy is true. When use_proxy is true, prx_ip, prx_port, username, and password will be used to communicate with the proxy server, thus prx_ip cannot be 0.0.0.0 and if the prx_port value is 0 it means the default proxy port is 8080. When the conn_type is HTTPS_CONN_TYPE_WSP_CO or HTTPS_CONN_TYPE_WSP_CL, the use_proxy is true by default. However, if the application simply wants to use the current setting used in WAP, then just set use_default as true and ignore all proxy server, thus prx_ip cannot be 0.0.0.0 and if the prx_port value is 0 it means the default proxy port is 8080.

When the conn_type is HTTPS_CONN_TYPE_WSP_CO or HTTPS_CONN_TYPE_WSP_CL, then by default use_proxy is true. However, if the application simply wants to use the current setting in WAP, then set use_default as true and ignore all other parameters. Static_header (if necessary) must be filled in WAP_PROF_CONN_TYPE_WSP_CO and the first WSP request of some dedicated channel with connection type WSP_CONN_TYPE_WSP_CL. If the application doesn't specify static_header, then HTTPS will use the value currently used by WAP.

Parameters

Parameters	Description
VMUINT16 request_id	[IN] The request ID.
VMBOOL use_proxy	[IN] This indicates whether it uses proxy or not.
VMUINT8 proxy_ip[4]	[IN] The proxy IP address.
VMUINT16 proxy_port	[IN] The proxy port number. 0 means default proxy 8080.
VMSTR username	[IN] The username for the proxy. Only ASCII is allowed and NULL terminated.
VMUINT8 username_length	[IN] The length should not exceed 40 characters excluding NULL character.
VMSTR password	[IN] The password for the proxy. Only ASCII is allowed and it is NULL terminated.
VMUINT8 password_length	[IN] The length should not exceed 40 character excluding NULL character.
VMSTR server_authorize_username	[IN] The username for the origin server. Only ASCII is allowed and it is NULL terminated.
VMSTR server_authorize_password	[IN] The length should not exceed 128 character excluding NULL character.
VMSTR static_header	[IN] The static header.
VMUINT32 static_header_length	[IN] The length of static header.
server_authorize_username_lengt	[IN] The length should not exceed 128 character excluding NULL character.
server_authorize_password_lengt	[IN] The length should not exceed 40 character excluding NULL character.

vmhttps.h

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.