The R_DhcpGetMScopeInfo method retrieves the information of the IPv4 multicast subnet managed by the MADCAP server. The caller of this function can free the memory pointed by MScopeInfo by calling the function midl_user_free (section 3).
DWORD R_DhcpGetMScopeInfo( [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress, [in, ref, string] LPWSTR* MScopeName, [out] LPDHCP_MSCOPE_INFO* MScopeInfo );
ServerIpAddress: The IP address/host name of the MADCAP server. This parameter is unused.
MScopeName: This is a pointer to a Unicode string that contains the name of the IPv4 multicast subnet for which the information is retrieved. There is no restriction on the length of this field.
MScopeInfo: This is a pointer of type LPDHCP_MSCOPE_INFO (section 2.2.1.2.71) in which the information for the IPv4 multicast subnet corresponding to MScopeName is retrieved.
Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully, else it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20099, or any generic failure.
|
Return value/code |
Description |
|---|---|
|
0x00000000 ERROR_SUCCESS |
The call was successful. |
|
0x00004E25 ERROR_DHCP_SUBNET_NOT_PRESENT |
The specified IPv4 subnet does not exist. |
The opnum field value for this method is 2.
When processing this call, the MADCAP server MUST do the following:
Validate if this method is authorized for read access per section 3.5.4. If not, return ERROR_ACCESS_DENIED.
Validate the MScopeName input variable. If this is NULL, return ERROR_INVALID_PARAMETER.
Allocate memory to MScopeInfo equal to the size of type DHCP_MSCOPE_INFO.
Retrieve the DHCPv4MScope entry corresponding to the MScopeName from the server ADM element DHCPv4MScopesList.
If the DHCPv4MScope entry corresponding to MScopeName is not found, free the memory allocated to MScopeInfo and return ERROR_DHCP_SUBNET_NOT_PRESENT.
Copy the information in DHCPv4MScope.MScopeInfo into the MScopeInfo structure, and return it to the caller.
Exceptions Thrown: No exceptions SHOULD be thrown beyond those thrown by the underlying RPC protocol specified in [MS-RPCE].