IcmpSetTimeout Function  
 
DWORD WINAPI IcmpSetTimeout(
  HCLIENT hClient,  
  DWORD dwTimeout  
);

The IcmpSetTimeout function sets the number of milliseconds the client will wait for a response from the remote host. Once the specified number of milliseconds has elapsed, the function will fail and return to the caller.

Parameters

hClient
Handle to the client session.
dwTimeout
The number of milliseconds until a blocking operation fails.

Return Value

If the function succeeds, the return value is the value of the timeout before the function was called. If the function fails, the return value is ICMP_ERROR. To get extended error information, call IcmpGetLastError.

Remarks

The timeout value is only used with blocking client connections.

Requirements

Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Import Library: csicmv11.lib

See Also

IcmpCreateHandle, IcmpGetTimeout