Functions
uint32	mxfServerVersionGet (HMXF_SERVER server, uint64 major, uint64 minor, uint64 *subMinor)

uint32	mxfServerUserCountGet (HMXF_SERVER server, uint64 *count)

uint32	mxfServerUserListGet (HMXF_SERVER server, uint64 maxCount, uint64 count, MXF_NETWORK_SERVER_USER_INFO users)

uint32	mxfServerUserDisconnect (HMXF_SERVER server, uint64 id)

uint32	mxfServerACLUserCountGet (HMXF_SERVER server, uint64 *count)

uint32	mxfServerACLUserListGet (HMXF_SERVER server, uint64 maxCount, uint64 count, MXF_ACL_USER users)

uint32	mxfServerACLUserGet (HMXF_SERVER server, MXF_ACL_USER *user)

uint32	mxfServerACLUserSet (HMXF_SERVER server, MXF_ACL_USER *user)

uint32	mxfServerACLUserRemove (HMXF_SERVER server, MXF_ACL_USER *user)

uint32	mxfServerACLUserAdd (HMXF_SERVER server, MXF_ACL_USER *user)

uint32	mxfServerACLUserPortAssignmentSet (HMXF_SERVER server, const char username, uint64 count, HMXF_CHANNEL channels)

uint32	mxfServerACLUserPortAssignmentGet (HMXF_SERVER server, const char username, uint64 maxCount, uint64 count, HMXF_CHANNEL *channels)

uint32	mxfServerACLUserWriteToFlash (HMXF_SERVER server)

Detailed Description

Function Documentation

uint32 mxfServerVersionGet	(	HMXF_SERVER	server,
		uint64 *	major,
		uint64 *	minor,
		uint64 *	subMinor
	)

C#: public static extern UInt32 mxfServerVersionGet(UInt64 server, out UInt64 major, out UInt64 minor, out UInt64 subminor);

Returns the version of the remote server. To get the version of the local server (server running on the system), you have to connect to it (for example, by connecting to ip address 127.0.0.1). When connected locally (with ip address 0.0.0.0), this function is not available, no server is in fact used in this case.

Parameters

[in]	server	server handle
[out]	major	major version
[out]	minor	minor version
[out]	subMinor	sub minor version

example: If major is 4, minor is 1 and subMinor is 12, version is 4.1.12

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerConnect()

uint32 mxfServerUserCountGet	(	HMXF_SERVER	server,
		uint64 *	count
	)

C#: public static extern UInt32 mxfServerUserCountGet(UInt64 server, out UInt64 count);

Returns the number of users connected to a MX Foundation's server. Admin privileges is required to use this function.

Parameters

[in]	server	server handle
[out]	count	number of users connected to the server

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerConnect()

uint32 mxfServerUserListGet	(	HMXF_SERVER	server,
		uint64	maxCount,
		uint64 *	count,
		MXF_NETWORK_SERVER_USER_INFO *	users
	)

C#: public static extern UInt32 mxfServerUserListGet(UInt64 server, UInt64 maxCount, out UInt64 count, [Out] MXF_NETWORK_SERVER_USER_INFO[] users);

Returns the list of users connected to a MX Foundation's server. Admin privileges is required to use this function.

Parameters

[in]	server	server handle
[in]	maxCount	maximum number of users entries to return
[out]	count	number of users entries returned
[out]	users	pointer to the MXF_NETWORK_SERVER_USER_INFO array.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerConnect()

uint32 mxfServerUserDisconnect	(	HMXF_SERVER	server,
		uint64	id
	)

C#: public static extern UInt32 mxfServerUserDisconnect(UInt64 server, UInt64 id);

Disconnects the specified user from the MX Foundation's server. Admin privileges is required to use this function.

Parameters

[in]	server	server handle
[in]	id	user id

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerConnect()

uint32 mxfServerACLUserCountGet	(	HMXF_SERVER	server,
		uint64 *	count
	)

C#: public static extern UInt32 mxfServerACLUserCountGet(UInt64 server, out UInt64 count);

Returns the number of users in server configuration file. Admin privileges is required to use this function.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in]	server	server handle
[out]	count	number of users

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserListGet()

uint32 mxfServerACLUserListGet	(	HMXF_SERVER	server,
		uint64	maxCount,
		uint64 *	count,
		MXF_ACL_USER *	users
	)

C#: public static extern UInt32 mxfServerACLUserListGet(UInt64 server, UInt64 maxCount, out UInt64 count, [Out] MXF_ACL_USER[] users);

Returns the list of entries in server configuration file. Admin privileges is required to use this function.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in]	server	server handle
[in]	maxCount	maximum number of entries to return
[out]	count	number of entries returned
[out]	users	entries returned

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserCountGet(); mxfServerACLUserGet()

uint32 mxfServerACLUserGet	(	HMXF_SERVER	server,
		MXF_ACL_USER *	user
	)

C#: public static extern UInt32 mxfServerACLUserGet(UInt64 server, ref MXF_ACL_USER user);

Finds the user in the list of entries of server configuration file. Admin privileges is required to use this function.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in]	server	server handle
[in,out]	user	user to find. username must be set to the user name to find.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserListGet(); mxfServerACLUserSet(); mxfServerACLUserRemove()

uint32 mxfServerACLUserSet	(	HMXF_SERVER	server,
		MXF_ACL_USER *	user
	)

C#: public static extern UInt32 mxfServerACLUserSet(UInt64 server, MXF_ACL_USER user);

Changes the parameters for the user in the list of entries of server configuration file. Admin privileges is required to use this function. The username must already be present in the list of entries.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in]	server	server handle
[in]	user	user to change. mxfServerACLUserWriteToFlash() must be called to save the file in flash.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserAdd(); mxfServerACLUserWriteToFlash()

uint32 mxfServerACLUserRemove	(	HMXF_SERVER	server,
		MXF_ACL_USER *	user
	)

C#: public static extern UInt32 mxfServerACLUserRemove(UInt64 server, ref MXF_ACL_USER user);

Removes the user from the list of entries of server configuration file. Admin privileges is required to use this function.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in]	server	server handle
[in,out]	user	user to remove. username must be set to the user name to remove. mxfServerACLUserWriteToFlash() must be called to save the file in flash.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserWriteToFlash(); mxfServerACLUserGet(); mxfServerACLUserAdd()

uint32 mxfServerACLUserAdd	(	HMXF_SERVER	server,
		MXF_ACL_USER *	user
	)

C#: public static extern UInt32 mxfServerACLUserAdd(UInt64 server, ref MXF_ACL_USER user);

Adds the user from the list of entries of server configuration file. Admin privileges is required to use this function.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in]	server	server handle
[in,out]	user	user to add. username must be set to the user name to add. mxfServerACLUserWriteToFlash() must be called to save the file in flash.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserWriteToFlash(); mxfServerACLUserSet(); mxfServerACLUserRemove()

uint32 mxfServerACLUserPortAssignmentSet	(	HMXF_SERVER	server,
		const char *	username,
		uint64	count,
		HMXF_CHANNEL *	channels
	)

C#: public static extern UInt32 mxfServerACLUserPortAssignmentSet(UInt64 server, string username, UInt64 count, UInt64[] channels);

Sets the list of channels a user should use. Admin privileges is required to use this function. When set, mxfServerACLUserWriteToFlash() must be called to save the list in flash.

Parameters

[in]	server	server handle
[in]	username	username associated with this list
[in]	count	number of channels in channel list
[in]	channels	list of channel handles to associate to this user

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfServerACLUserPortAssignmentGet(); mxfServerACLUserWriteToFlash()

uint32 mxfServerACLUserPortAssignmentGet	(	HMXF_SERVER	server,
		const char *	username,
		uint64	maxCount,
		uint64 *	count,
		HMXF_CHANNEL *	channels
	)

C#: public static extern UInt32 mxfServerACLUserPortAssignmentGet(UInt64 server, string username, UInt64 maxCount, out UInt64 count, [Out] UInt64[] channels);

Gets the list of channels a user should use.

Parameters

[in]	server	server handle
[in]	username	username associated with this list
[in]	maxCount	maximum number of channels to return
[out]	count	number of channels in channel list
[out]	channels	list of channel handles associated to this user

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfServerACLUserPortAssignmentSet()

uint32 mxfServerACLUserWriteToFlash ( HMXF_SERVER server )

C#: public static extern UInt32 mxfServerACLUserWriteToFlash(UInt64 server);

Writes the modification to server configuration file to nor-flash. Admin privileges is required to use this function.

flexchangeacl can also be used to perform changes to server configuration file.

Parameters

[in] server server handle

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfServerACLUserAdd(); mxfServerACLUserRemove()

Functions

Detailed Description

Function Documentation