Important: The information in this document is obsolete and should not be used for new development.
ASPGetParms
TheASPGetParms
function returns the maximum size of the data that you can send and receive across an ASP session and the maximum number of concurrent ASP sessions that the .XPP driver running on your node supports.
FUNCTION ASPGetParms (thePBptr: XPPParmBlkPtr; async: Boolean): OSErr;
thePBptr
- A pointer to an XPP parameter block.
async
- A Boolean that specifies whether the function should be executed asynchronously or synchronously. Specify
TRUE
for asynchronous execution.
Field Description
aspMaxCmdSize
- The maximum size in bytes of a command that you can send to
the server.aspQuantumSize
- The maximum size in bytes of the data that you can either request ASP to transfer to the server in an
ASPUserWrite
function call or receive from the server in a command reply.numSesss
- The number of concurrent ASP sessions that the .XPP driver supports on your node.
DESCRIPTION
TheASPGetParms
function returns information about the data capacity of an ASP session that you need to know to send commands using theASPUserCommand
andASPUserWrite
functions and write data using theASPUserWrite
function. It also
tells you how many concurrent ASP sessions your node supports. You do not need to establish a session before you call theASPGetParms
function.SPECIAL CONSIDERATIONS
Note that you must provide the .XPP driver reference number as an input parameter
to this function. You can obtain the driver reference number by calling the Device Manager'sOpenDriver
function.ASSEMBLY-LANGUAGE INFORMATION
To execute theASPGetParms
function from assembly language, call the_Control
trap macro with a value ofgetParms
in thecsCode
field of the parameter block. You must also specify the .XPP driver reference number. To execute the_Control
trap asynchro-
nously, include the value,ASYNC
in the operand field.RESULT CODES
noErr 0 No error