RasAdminReleaseIpAddress
[New
- Windows NT]
The RasAdminReleaseIpAddress
function is an application-defined function that is exported by a third-party
RAS server administration DLL. RAS calls this function to notify your DLL that
the remote client was disconnected and that the IP address should be released.
VOID RasAdminReleaseIpAddress(
WCHAR *lpszUserName, |
// pointer to the
name of the remote user |
WCHAR *lpszPortName, |
// pointer to the
name of the port |
IPADDR *pipAddress |
// pointer to the
IP address |
); |
|
Parameters
lpszUserName
Pointer to a
null-terminated Unicode string that contains the name of a remote user for whom
an IP address was previously obtained using the RasAdminGetIpAddressForUser
lpszPortName
Pointer to a
null-terminated Unicode string that contains the name of the port on which the
user specified by lpszUserName is connected.
pipAddress
Pointer to an
IPADDR variable that contains the IP address returned for this user in a
previous call to RasAdminGetIpAddressForUser88E4A9.
Return Values
None.
Remarks
The RAS
server calls your RasAdminReleaseIpAddress function only if your
application returned TRUE in the bNotifyRelease parameter during the
earlier call to RasAdminGetIpAddressForUser
The setup
program for a third-party RAS administration DLL must register the DLL with RAS
by providing information under the following key in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\RAS\AdminDll
To register
the DLL, set the following values under this key.
Value
Name |
Value
Data |
DisplayName |
A REG_SZ
string that contains the user-friendly display name of the DLL. |
DLLPath |
A REG_SZ
string that contains the full path of the DLL. |
For example,
the registry entry for a RAS Administration DLL from a fictional company named
Netwerks Corporation might be:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\RAS\AdminDll
DisplayName : REG_SZ
: Netwerks RAS Admin DLL
DLLPath : REG_SZ
: C:\nt\system32\ntwkadm.dll
The setup
program for a RAS Administration DLL should also provide remove/uninstall
functionality. If a user removes the DLL, the setup program should delete the
DLL s registry entries.
See Also