gm_set_acceptable_sizes.c File Reference

#include "gm_internal.h"

Functions
GM_ENTRY_POINT gm_status_t	gm_set_acceptable_sizes (struct gm_port *p, enum gm_priority priority, gm_size_t mask)

---

Detailed Description

This file contains the GM API function gm_set_acceptable_sizes().

---

Function Documentation

GM_ENTRY_POINT gm_status_t gm_set_acceptable_sizes (  struct gm_port *  p, enum gm_priority  priority, gm_size_t  mask )

gm_set_acceptable_sizes() informs GM of the acceptable sizes of GM messages received on port p with priority priority. Each set bit of mask indicates an acceptable size. While calling this function is not required, clients should call it during program initialization to detect errors involving the reception of badly sized messages to be reported nearly instantaneously, rather than after a substantial delay of 30 seconds or more. Note: the MASK is a long to support larger than 2GByte packets (those with size larger than 31). Return values: GM_SUCCESS  Operation completed successfully. GM_PERMISSION_DENIED  Port number hasn't been set. GM_INTERNAL_ERROR  LANai is not running. GM_INVALID_PARAMETER  The priority has an invalid value. Parameters: p  (IN) The GM port in use. priority  (IN) The priority of the message. mask  Author: Glenn Brown Version: GM_API_VERSION (as defined in gm.h)

---