Return codes of the ScanClientStreamStart function, provided in the Symantec Scan Engine SDK

Article:TECH167694  |  Created: 2011-08-22  |  Updated: 2012-04-02  |  Article URL
Article Type
Technical Solution


What are the return codes of the ScanClientStreamStart function, from the Symantec Scan Engine SDK?


Symantec Scan Engine SDK



The ScanClientStreamStart function is used for scanning streams. It can also be used to scan an input stream rather than an entire file at one time. For example, if a file is being received through an HTTP stream as a user uploads a file to a Web site, stream scanning can be used.

Note: The pszOriginalFileName parameter must be Unicode UTF-8 encoded.

LPSTR pszOriginalFileName,
LPSTR pszConfigPolicy,

ScanClientStreamStart parameters
The following table explains the ScanClientStreamStart parameters:

Parameter Description
hScanClient This parameter should be set up using ScanClientStartUp().
pszOriginalFileName The original name of the file to be scanned as it was named on the user’s computer.
pszConfigPolicy A null-terminated string in the form: <option:value>;;;<option:value>... No spaces are allowed in the string.
phScanStream Pointer to an HSCANSTREAM variable.

ScanClientStreamStart return codes
The following table explains the codes returned by ScanClientStreamStart:

Value Return code Description
7 SC_SERVER_TOO_BUSY Server is busy and unable to process the scan request.
6 SC_CONNECT_FAILURE Attempt to connect to a Symantec Scan Engine failed.
3 SC_MEMORY_ERROR A memory allocation error has occurred.
2 SC_SOCKET_FAILURE A socket communication error has occurred.
1 SC_INVALID_PARAMETER A parameter that was passed to the function was invalid.
0 SC_OK Success





ScanClientStreamStart function description.
ScanClientStreamStart.pdf (83 kBytes)

Article URL

Terms of use for this information are found in Legal Notices