McastRequestAddress function (madcapcl.h)

The McastRequestAddress function requests one or more multicast addresses from a MADCAP server.

Syntax

DWORD McastRequestAddress(
  [in]      IP_ADDR_FAMILY        AddrFamily,
  [in]      LPMCAST_CLIENT_UID    pRequestID,
  [in]      PMCAST_SCOPE_CTX      pScopeCtx,
  [in]      PMCAST_LEASE_REQUEST  pAddrRequest,
  [in, out] PMCAST_LEASE_RESPONSE pAddrResponse
);

Parameters

[in] AddrFamily

Specifies the address family to be used in the request, in the form of an IPNG_ADDRESS structure. Use AF_INET for IPv4 addresses and AF_INET6 for IPv6 addresses.

[in] pRequestID

Pointer to a unique identifier for the request, in the form of an MCAST_CLIENT_UID structure. Clients are responsible for ensuring that each request contains a unique identifier; unique identifiers can be obtained by calling the McastGenUID function.

[in] pScopeCtx

Pointer to the context of the scope from which the address is to be allocated, in the form of an MCAST_SCOPE_CTX structure. The scope context must be retrieved by calling the McastEnumerateScopes function prior to calling the McastRequestAddress function.

[in] pAddrRequest

Pointer to the MCAST_LEASE_REQUEST structure containing multicast lease–request parameters.

[in, out] pAddrResponse

Pointer to a buffer containing response parameters for the multicast address request, in the form of an MCAST_LEASE_RESPONSE structure. The caller is responsible for allocating sufficient buffer space for the pAddrBuf member of the MCAST_LEASE_RESPONSE structure to hold the requested number of addresses; the caller is also responsible for setting the pointer to that buffer.

Return value

The McastRequestAddress function returns the status of the operation.

Remarks

Before the McastRequestAddress function is called, the scope context must be retrieved by calling the McastEnumerateScopes function.

Requirements

See also

IPNG_ADDRESS

MCAST_CLIENT_UID

MCAST_LEASE_REQUEST

MCAST_LEASE_RESPONSE

MCAST_SCOPE_CTX

MCAST_SCOPE_ENTRY

McastApiCleanup

McastApiStartup

McastEnumerateScopes

McastGenUID

McastReleaseAddress

McastRenewAddress