87
Explicit Message API Functions
Section 4-6
Arguments
Return Value
TRUE is returned if the size of the event was read successfully. FALSE is
returned if an error occurred, such as the lack of a corresponding event.
Detailed error information can be read with the GetLastError() function.
Description
Set aside a buffer for storing service data that is at least as large as the
request obtained using this function, before using SCAN_Receive
ServerExplicit() to get the request message.
SERVER_REQ Structure
This structure defines the format of server request explicit messages. This
structure is used in the SCAN_ReceiveServerExplicit() function.
Reading a Server Explicit Message: SCAN_ReceiveServerExplicit()
Application Range
Online status
Function
Gets a server request message from the reception queue.
Call Format
BOOL SCAN_ReceiveServerExplicit(DWORD
Handle
, SERVER_REQ*
Msg
)
Type
Name
Contents
DWORD
Handle
Device handle obtained by SCAN_Open()
WORD
ClassId
Class ID of the destination for the request for which
the request size is being read.
DWORD*
Length
Buffer address for receiving the request size.
Type
Name
Contents
DWORD
MessageID
Message ID
Stores the server request message ID when the
function is completed.
WORD
ServiceCode
Service code
Stores the service code for the server request when
the function is completed.
WORD
ClassID
Class ID
Specifies the class ID for the server request to be
obtained, before the function is called.
WORD
InstanceID
Instance ID
Stores the instance ID for the server request when
the function is completed.
WORD
DataLength
The size (in bytes) of the buffer containing the ser-
vice data
Setting range: 0x0 to 0x228 (0 to 552)
Specifies the size of the buffer reserved for storing
the service data before calling the function.
A buffer for storing service data must be reserved
that is the size of the reception request buffer
obtained using the server notification message or
SCAN_GetServerEventLength().
When the function is completed, the number of
bytes of service data that was actually stored will be
set.
BYTE*
ServiceData
Service data storage buffer address
The number of bytes of service data specified under
DataLength must be set aside.
When the function is completed, the received ser-
vice data is stored in the buffer at the address spec-
ified here.
Summary of Contents for DeviceNet 3G8F7-DRM21-E
Page 1: ...OPERATION MANUAL Cat No W381 E1 02 3G8F7 DRM21 E DeviceNet PCI Board ...
Page 2: ...3G8F7 DRM21 E DeviceNet PCI Board Operation Manual Revised July 2005 ...
Page 3: ...iv ...
Page 5: ...vi ...
Page 29: ...12 Preparation for Operation Section 1 8 ...
Page 67: ...50 PC Watchdog Timer Management Function Section 3 11 ...
Page 115: ...98 Maintenance API Functions Section 4 7 ...
Page 131: ...114 Remote I O Communications Characteristics Section 6 1 ...
Page 145: ...Index 128 ...
Page 147: ...130 Revision History ...