IRdNtSharedSpacesListDisp Interface Reference

Inherits IDispatch.

List of all members.

Public Member Functions
HRESULT	Clear (void)
HRESULT	Add ([in] BSTR bstrSharedSpace,[in] RtDWORD dwParticipants)
HRESULT	Remove ([in] BSTR bstrSharedSpace)
HRESULT	GetCount ([out, retval] RtDWORD *pdwNum)
HRESULT	GetSSName ([in] RtDWORD dwIndex,[out, retval] BSTR *pbstrSharedSpace)
HRESULT	GetSSNumParts ([in] RtDWORD dwIndex,[out, retval] RtDWORD *pdwParticipants)

---

Detailed Description

---

Member Function Documentation

HRESULT IRdNtSharedSpacesListDisp::Clear

(

void

)

Call to erase all records.

    var netSSlist = System.CreateDO('Network Package/Net Shared Spaces List');
    netSSlist.Clear();

HRESULT IRdNtSharedSpacesListDisp::Add	(	[in] BSTR	bstrSharedSpace,
		[in] RtDWORD	dwParticipants
	)

Add Shared Space name.

Parameters:

bstrSharedSpace

[in] The Shared Space node name.

Returns:

dwParticipants [in] Number of logged in participants.

    var space = Space.CurrentScene();
    netSSlist.Add(space, 1); // ss-name and number of participants. 

HRESULT IRdNtSharedSpacesListDisp::Remove

(

[in] BSTR

bstrSharedSpace

)

Remove Shared Space node name.

Parameters:

bstrSharedSpace

[in] The Shared Space node name you want to remove.

 netSSlist.Remove(ssName); 

HRESULT IRdNtSharedSpacesListDisp::GetCount

(

[out, retval] RtDWORD *

pdwNum

)

Retrieve number of records.

Returns:

pdwNum [out, retval] Returns number of records/shared spaces in list.

 var countSS = netSSlist.GetCount(); 

HRESULT IRdNtSharedSpacesListDisp::GetSSName	(	[in] RtDWORD	dwIndex,
		[out, retval] BSTR *	pbstrSharedSpace
	)

Get Shared Space name by index.

Parameters:

dwIndex

[in] Record index.

Returns:

pbstrSharedSpace [out, retval] If successful, then returns Shared Space's name.

 var ssName = netSSlist.GetSSName(countSS); 

HRESULT IRdNtSharedSpacesListDisp::GetSSNumParts	(	[in] RtDWORD	dwIndex,
		[out, retval] RtDWORD *	pdwParticipants
	)

Get number of connected participants of a Shared Space.

Parameters:

dwIndex

[in] Record index.

Returns:

pdwParticipants [out, retval] If successful, then returns number of connected participants in the Shared Space's name.

 var ssParts = netSSlist.GetSSNumParts(countSS);