IAPI::EnableSocketObjectFreeMessageUsage

property EnableSocketObjectFreeMessageUsage.

Disables the predefined encapsulation algo used by ScriptEZ.API to transport and to warrant good delivery of application messages.

This default messages encapsulation relies on a simple zero-left-padding 10 characters header which contains the length of a message,

and is followed by the real message payload itself (<10 bytes zero-left-padding hdr><Payload>): e.g “0000000009ABCDEFGHI”

On the other hand, when calling EnableSocketObjectDataEncryption( ) or EnableNamedPipeObjectDataEncryption( ), the component

will apply a second undisclosed algo which encrypts data before sending into a socket or a named pipe stream. This involves necessarily

to program both peers with ScriptEZ.API object.

/!\ Be aware that “free message usage” involves more endeavour from packaging and unpackaging application messages.

Those tasks will be on your own in order to warrant properly a good delivery of application messages.

HRESULT EnableSocketObjectFreeMessageUsage(
 long hSocketObject,
 BOOL flag,
 BOOL *pVal
);

Parameters

hSocketObject

[in] . Handle of socket object

flag

[in] . TRUE, disables predefined encapsulation algo and uses free message

FALSE, enables predefined encapsulation

pVal

[out, retval] The returned value is TRUE if succeeded, FALSE if failed.

Return Values

S_OK

The operation was successfull.

E_POINTER

A NULL pointer was supplied as an argument.

E_UNEXPECTED

An unexpected error occoured.

See Also

IAPI