McastApiStartup function

The McastApiStartup function facilitates MADCAP-version negotiation between requesting clients and the version of MADCAP implemented on the system. Calling McastApiStartup allocates necessary resources; it must be called before any other MADCAP client functions are called.

Syntax

DWORD McastApiStartup(
  IN OUT PDWORD Version
);

Parameters

Version

Pointer to the version of multicast (MCAST) that the client wishes to use.

[out] Pointer to the version of MCAST implemented on the system.

Return Value

If the client requests a version of MADCAP that is not supported by the system, the McastApiStartup function returns ERROR_NOT_SUPPORTED. If resources fail to be allocated for the function call, ERROR_NO_SYSTEM_RESOURCES is returned.

Remarks

Clients can specify which version they want to use in the pVersion parameter. If the system's implementation supports the requested MCAST version, the function call succeeds. If the system's implementation does not support the requested version, the function fails with MCAST_API_CURRENT_VERSION.

The client can automatically negotiate the first version of MCAST (MCAST_API_VERSION_1) by setting the pVersion parameter to zero.

The McastApiStartup function always returns the most recent version of MADCAP available on the system (MCAST_API_CURRENT_VERSION) in pVersion, enabling clients to discover the most recent version implemented on the system.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header madcapcl.h
Library Dhcpcsvc.lib
DLL Dhcpcsvc.dll

See Also

IPNG_ADDRESS

MCAST_CLIENT_UID

MCAST_LEASE_REQUEST

MCAST_LEASE_RESPONSE

MCAST_SCOPE_CTX

MCAST_SCOPE_ENTRY

McastApiCleanup

McastEnumerateScopes

McastGenUID

McastReleaseAddress

McastRenewAddress

McastRequestAddress