MTC 成员接口函数 更多

类型定义
typedef enum EN_MTC_PARTP_LST_TYPE	EN_MTC_PARTP_LST_TYPE
	MTC 成员列表类型
typedef enum EN_MTC_PARTP_STAT_TYPE	EN_MTC_PARTP_STAT_TYPE
	MTC 成员状态类型
typedef enum EN_MTC_PARTP_ISCOMP_STAT_TYPE	EN_MTC_PARTP_ISCOMP_STAT_TYPE
	MTC 成员组成状态类型
typedef enum EN_MTC_PARTP_ROLES_TYPE	EN_MTC_PARTP_ROLES_TYPE
	MTC 成员角色类型
typedef enum EN_MTC_PARTP_ETYPE_TYPE	EN_MTC_PARTP_ETYPE_TYPE
	MTC 成员 etype 类型

枚举
enum	EN_MTC_PARTP_LST_TYPE {   EN_MTC_PARTP_LST_ONE,   EN_MTC_PARTP_LST_PREDEF_GRP,   EN_MTC_PARTP_LST_URI_LST }
	MTC 成员列表类型 更多
enum	EN_MTC_PARTP_STAT_TYPE {   EN_MTC_PARTP_STAT_PENDING,   EN_MTC_PARTP_STAT_ACTIVE,   EN_MTC_PARTP_STAT_INACITVE,   EN_MTC_PARTP_STAT_DEPARTED,   EN_MTC_PARTP_STAT_BOOTED,   EN_MTC_PARTP_STAT_FAILED,   EN_MTC_PARTP_STAT_DELETED }
	MTC 成员状态类型 更多
enum	EN_MTC_PARTP_ISCOMP_STAT_TYPE {   EN_MTC_PARTP_ISCOMP_STAT_UNKNOWN,   EN_MTC_PARTP_ISCOMP_STAT_IDLE,   EN_MTC_PARTP_ISCOMP_STAT_ACTIVE }
	MTC 成员组成状态类型 更多
enum	EN_MTC_PARTP_ROLES_TYPE {   EN_MTC_PARTP_ROLES_UNKNOWN,   EN_MTC_PARTP_ROLES_CHAIRMAN,   EN_MTC_PARTP_ROLES_PARTP }
	MTC 成员角色类型 更多
enum	EN_MTC_PARTP_ETYPE_TYPE {   EN_MTC_PARTP_ETYPE_UNKNOWN,   EN_MTC_PARTP_ETYPE_GPMANAGE }
	MTC 成员 etype 类型 更多

函数
ZFUNC ZULONG	Mtc_PartpLstCreate (ZULONG dwType)
	创建一个成员列表。 更多
ZFUNC ZVOID	Mtc_PartpLstDelete (ZULONG dwLstId)
	删除一个成员列表。 更多
ZFUNC ZULONG	Mtc_PartpLstClone (ZULONG dwLstId)
	复制一个成员列表。 更多
ZFUNC ZULONG	Mtc_PartpLstGetType (ZULONG dwLstId)
	获取成员列表类型。 更多
ZFUNC ZINT	Mtc_PartpLstSetType (ZULONG dwLstId, ZULONG dwType)
	设置成员列表类型。 更多
ZFUNC ZINT	Mtc_PartpLstGetSize (ZULONG dwLstId)
	获取成员列表大小。 更多
ZFUNC ZINT	Mtc_PartpLstGetPartp (ZULONG dwLstId, ZINT iIndex, ZCHAR **ppcName, ZCHAR **ppcUri, ZULONG *pdwPartpId)
	从成员列表获取一位成员。 更多
ZFUNC ZULONG	Mtc_PartpLstAddPartp (ZULONG dwLstId, ZCHAR *pcName, ZCHAR *pcUri)
	添加一位成员到成员列表。 更多
ZFUNC ZINT	Mtc_PartpLstRmvPartp (ZULONG dwLstId, ZULONG dwPartpId)
	从成员列表移除一位成员。 更多
ZFUNC ZULONG	Mtc_PartpLstFindPartp (ZULONG dwLstId, ZCHAR *pcUri)
	在成员列表中找到一位成员。 更多
ZFUNC ZCHAR *	Mtc_PartpGetName (ZULONG dwPartpId)
	从成员列表获取成员名称。 更多
ZFUNC ZCHAR *	Mtc_PartpGetUri (ZULONG dwPartpId)
	从成员获取成员 URI。 更多
ZFUNC ZUINT	Mtc_PartpGetStat (ZULONG dwPartpId)
	从成员列表获取成员状态。 更多
ZFUNC ZUINT	Mtc_PartpGetRoles (ZULONG dwPartpId)
	从成员列表获取成员角色。 更多
ZFUNC ZUINT	Mtc_PartpGetEtype (ZULONG dwPartpId)
	获取成员 etype。 更多
ZFUNC ZUCHAR	Mtc_PartpGetCompsStat (ZULONG dwPartpId)
	获取以为成员的组成状态。 更多
ZFUNC ZULONG	Mtc_PartpGetSessId (ZULONG dwPartpId)
	从成员列表获取成员会话 ID。 更多
ZFUNC ZINT	Mtc_PartpSetSessId (ZULONG dwPartpId, ZULONG dwSessId)
	设置成员会话 ID。 更多
ZFUNC ZULONG	Mtc_PartpGetLogId (ZULONG dwPartpId)
	获取成员记录 ID。 更多
ZFUNC ZINT	Mtc_PartpSetLogId (ZULONG dwPartpId, ZULONG dwLogId)
	设置成员记录 ID。 更多

详细描述

MTC 成员接口函数

枚举类型说明

enum EN_MTC_PARTP_ETYPE_TYPE

MTC 成员 etype 类型

枚举值
EN_MTC_PARTP_ETYPE_UNKNOWN	未知类型
EN_MTC_PARTP_ETYPE_GPMANAGE	群组管理类型

enum EN_MTC_PARTP_ISCOMP_STAT_TYPE

MTC 成员组成状态类型

枚举值
EN_MTC_PARTP_ISCOMP_STAT_UNKNOWN	组成未知状态
EN_MTC_PARTP_ISCOMP_STAT_IDLE	组成静止状态
EN_MTC_PARTP_ISCOMP_STAT_ACTIVE	组成活跃状态

enum EN_MTC_PARTP_LST_TYPE

MTC 成员列表类型

枚举值
EN_MTC_PARTP_LST_ONE	一位成员
EN_MTC_PARTP_LST_PREDEF_GRP	预定义群成员
EN_MTC_PARTP_LST_URI_LST	URI 列表成员

enum EN_MTC_PARTP_ROLES_TYPE

MTC 成员角色类型

枚举值
EN_MTC_PARTP_ROLES_UNKNOWN	未知角色
EN_MTC_PARTP_ROLES_CHAIRMAN	群主
EN_MTC_PARTP_ROLES_PARTP	群成员

enum EN_MTC_PARTP_STAT_TYPE

MTC 成员状态类型

枚举值
EN_MTC_PARTP_STAT_PENDING	等待
EN_MTC_PARTP_STAT_ACTIVE	活跃
EN_MTC_PARTP_STAT_INACITVE	不活跃
EN_MTC_PARTP_STAT_DEPARTED	离开
EN_MTC_PARTP_STAT_BOOTED	踢出
EN_MTC_PARTP_STAT_FAILED	失败
EN_MTC_PARTP_STAT_DELETED	删除

函数说明

ZFUNC ZUCHAR Mtc_PartpGetCompsStat (ZULONG dwPartpId)

获取以为成员的组成状态。

参数

[in]

dwPartpId

成员 ID。

返回

成员组成状态，见 EN_MTC_PARTP_ISCOMP_STAT_TYPE.

ZFUNC ZUINT Mtc_PartpGetEtype (ZULONG dwPartpId)

获取成员 etype。

参数

[in]

dwPartpId

成员 ID。

返回

成员 etype，见 EN_MTC_PARTP_ETYPE_TYPE.

ZFUNC ZULONG Mtc_PartpGetLogId (ZULONG dwPartpId)

获取成员记录 ID。

参数

[in]

dwPartpId

成员 ID。

返回

成员记录 ID。

ZFUNC ZCHAR* Mtc_PartpGetName (ZULONG dwPartpId)

从成员列表获取成员名称。

参数

[in]

dwPartpId

成员 ID。

返回

成员名称字符串，当获取成员名称成功， 否则返回空字符串。 调用方必须先复制再使用。

ZFUNC ZUINT Mtc_PartpGetRoles (ZULONG dwPartpId)

从成员列表获取成员角色。

参数

[in]

dwPartpId

成员 ID。

返回

成员角色，见 EN_MTC_PARTP_ROLES_TYPE.

ZFUNC ZULONG Mtc_PartpGetSessId (ZULONG dwPartpId)

从成员列表获取成员会话 ID。

参数

[in]

dwPartpId

成员 ID。

返回

成员会员 ID。

ZFUNC ZUINT Mtc_PartpGetStat (ZULONG dwPartpId)

从成员列表获取成员状态。

参数

[in]

dwPartpId

成员 ID。

返回

成员状态，见 EN_MTC_PARTP_STAT_TYPE。

ZFUNC ZCHAR* Mtc_PartpGetUri (ZULONG dwPartpId)

从成员获取成员 URI。

参数

[in]

dwPartpId

成员 ID。

返回

成员 URI，当获取成员 URI成功， 否则返回空字符串。 调用方必须先复制再使用。

ZFUNC ZULONG Mtc_PartpLstAddPartp (ZULONG dwLstId, ZCHAR * pcName, ZCHAR * pcUri )

添加一位成员到成员列表。

参数

[in]	dwLstId	成员列表 ID。
[in]	pcName	成员名称。
[in]	pcUri	成员 URI。

返回值

成员ID，当添加成员成功，

否则返回 ZMAXULONG。

ZFUNC ZULONG Mtc_PartpLstClone (ZULONG dwLstId)

复制一个成员列表。

参数

[in]

dwLstId

成员列表 ID。

返回

新列表 ID，若复制一个成员列表成功， 否则返回 ZMAXULONG.

ZFUNC ZULONG Mtc_PartpLstCreate (ZULONG dwType)

创建一个成员列表。

参数

[in]

dwType

成员类型，见 EN_MTC_PARTP_LST_TYPE.

返回

列表 ID，当创建一个成员列表成功， 否则返回 ZMAXULONG。

ZFUNC ZVOID Mtc_PartpLstDelete (ZULONG dwLstId)

删除一个成员列表。

参数

[in]

dwLstId

成员列表 ID。

ZFUNC ZULONG Mtc_PartpLstFindPartp (ZULONG dwLstId, ZCHAR * pcUri )

在成员列表中找到一位成员。

参数

[in]	dwLstId	成员列表 ID。
[in]	pcUri	成员 URI。

返回

成员 ID，若成员存在，否则返回 ZMAXULONG.

ZFUNC ZINT Mtc_PartpLstGetPartp (ZULONG dwLstId, ZINT iIndex, ZCHAR ** ppcName, ZCHAR ** ppcUri, ZULONG * pdwPartpId )

从成员列表获取一位成员。

参数

[in]	dwLstId	成员列表 ID。
[in]	iIndex	成员索引。
[out]	ppcName	成员名称。
[out]	ppcUri	成员 URI。
[out]	pdwPartpId	成员 ID。

调用方必须复制 *ppcName 和 *ppcUri，再使用。

返回值

ZOK	获取成员成功。
ZFAILED	获取成员失败。

ZFUNC ZINT Mtc_PartpLstGetSize (ZULONG dwLstId)

获取成员列表大小。

参数

[in]

dwLstId

成员列表 ID。

返回

成员列表大小。

ZFUNC ZULONG Mtc_PartpLstGetType (ZULONG dwLstId)

获取成员列表类型。

参数

[in]

dwLstId

成员列表 ID。

返回

成员列表类型，见 EN_MTC_PARTP_LST_TYPE.

ZFUNC ZINT Mtc_PartpLstRmvPartp (ZULONG dwLstId, ZULONG dwPartpId )

从成员列表移除一位成员。

参数

[in]	dwLstId	成员列表 ID。
[in]	dwPartpId	成员 ID。

返回值

ZOK	移除一位成员成功。
ZFAILED	移除一位成员失败。

ZFUNC ZINT Mtc_PartpLstSetType (ZULONG dwLstId, ZULONG dwType )

设置成员列表类型。

参数

[in]	dwLstId	成员列表 ID。
[in]	dwType	成员类型，见 EN_MTC_PARTP_LST_TYPE.

返回值

ZOK	设置成员列表类型成功。
ZFAILED	设置成员列表类型失败。

ZFUNC ZINT Mtc_PartpSetLogId (ZULONG dwPartpId, ZULONG dwLogId )

设置成员记录 ID。

参数

[in]	dwPartpId	成员 ID。
[in]	dwLogId	成员记录 ID。

返回值

ZOK	设置成员记录 ID 成功。
ZFAILED	设置成员记录 ID 失败。

ZFUNC ZINT Mtc_PartpSetSessId (ZULONG dwPartpId, ZULONG dwSessId )

设置成员会话 ID。

参数

[in]	dwPartpId	成员 ID。
[in]	dwSessId	成员会话 ID。

返回值

ZOK	设置成员会话 ID成功。
ZFAILED	设置成员会话 ID失败。