ScanStack method

Description

VWorks software calls the ScanStack method to tell the plugin to scan the stack at the specified location.

IMPORTANT VWorks software always calls the ScanStack method before the SinkPlate or SourcePlate method. See “SinkPlate method” and “SourcePlate method” .

Syntax

 

HRESULT ScanStack( [in] BSTR Location, [out,retval] enum ReturnCode *retVal );

Parameters

 

Location	[in] The name of the location of the stack.
retVal	[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

Related information

 

For information about...	See...
IsStackEmpty method	“IsStackEmpty method”
IsStackFull method	“IsStackFull method”
LoadStack method	“LoadStack method”
ReturnCode enumerated type	“ReturnCode enumerated type”
SinkPlate method	“SinkPlate method”
SourcePlate method	“SourcePlate method”
UnloadStack method	“UnloadStack method”