ClearHeaders

Syntax 1: for TokenRequest objects

Description

Clears the header of requests.

Applies to

TokenRequest objects

Syntax

objectname.ClearHeaders ( )

Argument

Description

objectname

A reference to the TokenRequest object in which you want to clear the request header.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs.

Examples

The following example shows the use of the ClearHeaders function to clear the value of all headers:

int li_return
TokenRequest lnv_TokenRequest

li_return = lnv_TokenRequest.clearheaders( )

See also

AppendParam

GetHeader

GetHeaders

SetHeader

SetHeaders

Syntax 2: for OAuthRequest objects

Description

Clears the header of requests.

Applies to

OAuthRequest objects

Syntax

objectname.ClearHeaders ( )

Argument

Description

objectname

A reference to the OAuthRequest object in which you want to clear the request header.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs.

Examples

The following example shows the use of the ClearHeaders function to clear the value of all headers:

int li_return
OAuthRequest lnv_OAuthRequest

li_return = lnv_OAuthRequest.clearheaders()

See also

GetBody

GetHeader

GetHeaders

SetAccessToken

SetBody

SetHeader

SetHeaders