MprAdminReleaseIpAddress function (mprapi.h)

The MprAdminReleaseIpAddress function is called when a user disconnects and the user's IP address is about to be released.

Syntax

void MprAdminReleaseIpAddress(
  [in] WCHAR *lpszUserName,
  [in] WCHAR *lpszPortName,
  [in] DWORD *lpdwIpAddress
);

Parameters

[in] lpszUserName

Pointer to a Unicode string that specifies the name of the user that requires an IP address.

[in] lpszPortName

Pointer to a Unicode string that specifies the name of the port on which the user is attempting to connect.

[in] lpdwIpAddress

Pointer to a DWORD variable. This variable specifies the IP address to be released.

Return value

None

Remarks

An administration DLL need not implement the MprAdminReleaseIpAddress function. However, if the DLL implements MprAdminReleaseIpAddress, it must also implement MprAdminGetIpAddressForUser.

RAS supports multiple Administration DLLs. However, RAS calls MprAdminReleaseIpAddress only in the first DLL that implements and export it. RAS ignores implementations of these functions in the other DLLs. RAS checks the DLLs for these functions in the order in which they are listed in the registry.

Windows 2000 Server or earlier:  If RAS does not accept the new link, RAS does not call the MprAdminLinkHangupNotification function.

Do not call any of the RAS Administration Functions or RAS User Administration Functions from inside MprAdminReleaseIpAddress. Calls to these functions do not return when made from within a callout function.

Requirements

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

See also

MprAdminConnectionHangupNotification

MprAdminGetIpAddressForUser

RAS Administration DLL

RAS Administration Functions

Remote Access Service Administration Reference