Edit

MCAST_LEASE_REQUEST structure (madcapcl.h)

  • Article

The MCAST_LEASE_REQUEST structure defines the request, renew, or release parameters for a given multicast scope. In the MCAST_API_VERSION_1 implementation, only one IP address may be allocated at a time.

Syntax

typedef struct _MCAST_LEASE_REQUEST {
  LONG         LeaseStartTime;
  LONG         MaxLeaseStartTime;
  DWORD        LeaseDuration;
  DWORD        MinLeaseDuration;
  IPNG_ADDRESS ServerAddress;
  WORD         MinAddrCount;
  WORD         AddrCount;
  PBYTE        pAddrBuf;
} MCAST_LEASE_REQUEST, *PMCAST_LEASE_REQUEST;

Members

LeaseStartTime

Requested start time, in seconds, for the multicast scope lease elapsed since midnight of January 1, 1970, coordinated universal time. To request the current time as the lease start time, set LeaseStartTime to zero.

MaxLeaseStartTime

Maximum start time, in seconds, elapsed since midnight of January 1, 1970, coordinated universal time, that the client is willing to accept.

LeaseDuration

Duration of the lease request, in seconds. To request the default lease duration, set both LeaseDuration and MinLeaseDuration to zero.

MinLeaseDuration

Minimum lease duration, in seconds, that the client is willing to accept.

ServerAddress

Internet Protocol (IP) address of the server on which the lease is to be requested or renewed, in the form of an IPNG_ADDRESS structure. If the IP address of the server is unknown, such as when using this structure in an McastRequestAddress function call, set ServerAddress to zero.

MinAddrCount

Minimum number of IP addresses the client is willing to accept.

AddrCount

Number of requested IP addresses. Note that the value of this member dictates the size of pAddrBuf.

pAddrBuf

Pointer to a buffer containing the requested IP addresses. For IPv4 addresses, the pAddrBuf member points to 4-byte addresses; for IPv6 addresses, the pAddrBuf member points to 16-byte addresses. If no specific addresses are requested, set pAddrBuf to NULL.

Remarks

In MCAST_API_VERSION_1 version, MaxLeaseStartTime, MinLeaseDuration, and MinAddrCount members are ignored. Clients should still set appropriate values for these members, however, to take advantage of their implementation in future updates.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header madcapcl.h

See also

IPNG_ADDRESS

MCAST_CLIENT_UID

MCAST_LEASE_RESPONSE

MCAST_SCOPE_CTX

MCAST_SCOPE_ENTRY

McastApiCleanup

McastApiStartup

McastEnumerateScopes

McastGenUID

McastRequestAddress