messiah_group.h


Provides Group related information and manipulation.

Version:
1.1
Date:
6/07/03


Functions

FXgroup fxGroupCreate (FXchar *name, FXint flags)
 Creates a new Group.

FXint fxGroupDelete (FXgroup group, FXint flags)
 Delete an existing Group.

FXint fxGroupName (FXgroup group, FXchar *buffer, FXint buffer_length, FXint flags)
 Get the name of a Group.

FXint fxGroupRename (FXgroup group, FXchar *name, FXint flags)
 Rename a Group.

FXint fxGroupMemberAdd (FXgroup group, FXentity member, FXint *ID, FXint flags)
 Add a member to a Group.

FXint fxGroupMemberRemove (FXgroup group, FXentity member, FXint ID, FXint flags)
 Remove a member from a Group.

FXint fxGroupFind (FXchar *name, FXgroup *group)
 Find a Group called name.


Function Documentation

FXgroup fxGroupCreate FXchar   name,
FXint    flags
 

Creates a new Group.

Parameters:
name [in] Name of the new Group
NAME [in] Reserved for future use
Returns:
An FXgroup ID if successful, FX_NULLID otherwise.

FXint fxGroupDelete FXgroup    group,
FXint    flags
 

Delete an existing Group.

Parameters:
grou [in] Group to delete
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxGroupFind FXchar   name,
FXgroup   group
 

Find a Group called name.

Parameters:
name [in] Name of the group to find
group [out] Storage for the FXgroup ID
Return values:
FX_TRUE on success
FX_FALSE on failure
If fxGroupFind() successfully finds the group you are looking for, then group will hold its ID.

FXint fxGroupMemberAdd FXgroup    group,
FXentity    member,
FXint   ID,
FXint    flags
 

Add a member to a Group.

Parameters:
group [in] Group to add member to
member [in] Member to add
ID [out] Storage for the index of the member in the Group
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxGroupMemberRemove FXgroup    group,
FXentity    member,
FXint    ID,
FXint    flags
 

Remove a member from a Group.

Parameters:
group [in] Group to remove member from
member [in] Member to remove
ID [in] Index of the member in the Group
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxGroupName FXgroup    group,
FXchar   buffer,
FXint    buffer_length,
FXint    flags
 

Get the name of a Group.

Parameters:
group [in] Group to get name from
buffer [out] Buffer to hold name
buffer_length [in] length of buffer
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
To get the name of a Group you must pass the address of a FXchar buffer. You need to indicate how big the buffer is that you've passed so that messiah will not attempt to write beyond it.

FXint fxGroupRename FXgroup    group,
FXchar   name,
FXint    flags
 

Rename a Group.

Parameters:
group [in] Group to rename
name [in] New name
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

Last Updated on Thu Jul 10 04:49:37 2003