MprConfigServerConnect function (mprapi.h)
The MprConfigServerConnect function connects to the router to be configured. Call this function before making any other calls to the server. The handle returned by this function is used in subsequent calls to configure interfaces and transports on the server.
Syntax
DWORD MprConfigServerConnect(
[in] LPWSTR lpwsServerName,
[out] HANDLE *phMprConfig
);
Parameters
[in] lpwsServerName
Pointer to a Unicode string that specifies the name of the remote server to configure. If this parameter is NULL, the function returns a handle to the router configuration on the local machine.
[out] phMprConfig
Pointer to a handle variable. This variable receives a handle to the router configuration.
Return value
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 |
---|---|
|
The phMprConfig parameter is NULL. |
|
Insufficient resources to complete the operation. |
|
Use FormatMessage to retrieve the system error message that corresponds to the error code returned. |
Requirements
Requirement | Value |
---|---|
Minimum supported client | None supported |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | mprapi.h |
Library | Mprapi.lib |
DLL | Mprapi.dll |