nf-mprapi-mpradminserverconnect.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:mprapi.MprAdminServerConnect	MprAdminServerConnect function (mprapi.h)	The MprAdminServerConnect function establishes a connection to a router for the purpose of administering that router.	MprAdminServerConnect MprAdminServerConnect function [RAS] _mpr_mpradminserverconnect mprapi/MprAdminServerConnect rras.mpradminserverconnect	rras\mpradminserverconnect.htm	RRAS	f93b37bc-d3d1-40f0-aef6-839bb43c88e2	12/05/2018	MprAdminServerConnect, MprAdminServerConnect function [RAS], _mpr_mpradminserverconnect, mprapi/MprAdminServerConnect, rras.mpradminserverconnect	mprapi.h		Windows	None supported	Windows 2000 Server [desktop apps only]										Mprapi.lib	Mprapi.dll		Windows			19H1	MprAdminServerConnect mprapi/MprAdminServerConnect	c++	APIRef kbSyntax	DllExport	Mprapi.dll	MprAdminServerConnect

MprAdminServerConnect function

-description

The MprAdminServerConnect function establishes a connection to a router for the purpose of administering that router. Call this function before making any other calls to the server. Use the handle returned in subsequent calls to administer interfaces on the server.

-parameters

-param lpwsServerName [in, optional]

A pointer to a null-terminated Unicode string that specifies the name of the remote server. If this parameter is NULL, the function returns a handle to the local machine.

-param phMprServer [out]

A pointer to a HANDLE variable that receives a handle to the server. Use this handle in subsequent calls to administer the server.

-returns

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value	Meaning
ERROR_ACCESS_DENIED	The calling application does not have sufficient privilege.
RPC_S_INVALID_BINDING	This function was called with phMprServer parameter equal to NULL.
RPC_S_UNKNOWN_IF	The specified computer is not running the Routing and RAS service.

-remarks

MprAdminIsServiceRunning must be used to determine the status of the RRAS service on the remote server. MprAdminServerConnect does not query the RRAS service when establishing a connection.

-see-also

MprAdminServerDisconnect

Router Administration Functions

Router Management Reference