FaxSession Object

The FaxSession object establishes a session on behalf of a FACSys user. In addition to establishing a context for the logged on user, the FaxSession object provides methods of accessing certain objects directly without having to traverse the object hierarchies.

Properties

Methods

Back to Top

Application Property

The Application property returns the name of the active application, the "Active Fax Messaging" library. Read-only.

Syntax

ObjSession.Application

Data Type

String

Remarks

The version number of the Active Fax Messaging Library is available through the FaxSession object’s Version property.

Back to Top

BroadcastLimit Property

The BroadcastLimit property returns the broadcast limit defined on the server for the logged on user. Read-only.

Syntax

ObjSession.BroadcastLimit

Data Type

Long

Remarks

If the user is not restricted to the broadcast limit (the user can define any number of destinations in a fax message), then 0 (zero) is returned. If the user cannot exceed the broadcast limit, then the limit (the maximum number of recipients) is returned.

Back to Top

CoverPages Property

The CoverPages property returns a FaxCoverPages collection object containing the FaxCoverPage objects available to the current session. Read-only.

Syntax

ObjSession.CoverPages

Data Type

FaxCoverPages object

Back to Top

CreateMessage Method

The CreateMessage method returns a new empty FaxMessage object.

Syntax

ObjSession.CreateMessage ( )

Remarks

The new FaxMessage object is sent only when you call the FaxMessage object's Send method.

Back to Top

DisplayName Property

The DisplayName property returns the display name of the currently logged on FaxUser. Read-only.

Syntax

ObjSession.DisplayName

Data Type

String

Back to Top

GetFolder Method

The GetFolder method returns the FaxFolder object having the FolderID you specify.

Syntax

ObjSession.GetFolder (FolderID)

Remarks

The returned FaxFolder object is accessed directly. After using the GetFolder method, you cannot access the returned FaxFolder's "parent" object.

Back to Top

GetMessage Method

The GetMessage method returns the FaxMessage object having the MessageID you specify.

Syntax

ObjSession.GetMessage (MessageID)

Remarks

The returned FaxMessage object is accessed directly. After using the GetMessage method, you cannot access the returned FaxMessage's "parent" object.

Back to Top

GetUser Method

The GetUser method returns the FaxUser object having the UserID you specify.

Syntax

ObjSession.GetUser (UserID)

Remarks

The returned FaxUser object is accessed directly. After using the GetUser method, you cannot access the returned FaxUser's "parent" object.

Back to Top

HasAccess Property

The HasAccess property indicates whether the current user has the specified access permission. Read-only.

Syntax

ObjSession.HasAccess (FSA)

Data Type

Boolean

Remarks

HasAccess will return a non-zero if the specified security attribute is set/enabled.

Valid values for this property are defined by the FaxMsg_FSA enumeration.

Back to Top

Logoff Method

The Logoff method terminates the current session.

Syntax

ObjSession.Logoff ( )

Back to Top

Logon Method

The Logon method attempts to establish a session with the specified server.

Syntax

ObjSession.Logon (ServerName [,UserName, Password])

Remarks

The Password (string) and UserName (string) parameters are optional. If you do not specify a UserName, the session is established using NT authentication.

Back to Top

Phonebooks Property

The Phonebooks property returns a FaxPhonebooks collection object containing the FaxPhonebook objects available to the current session. Read-only.

Syntax

ObjSession.Phonebooks

Data Type

FaxPhonebooks object

Back to Top

RootFolder Property

The RootFolder property returns the logged on user's top-level FaxFolder object (the user's mailbox) on the server. Read-only.

Syntax

ObjSession.RootFolder

Data Type

FaxFolder object

Back to Top

RootSystemFolder Property

The RootSystemFolder property returns the root FaxFolder object of the system folder collection on the current server. Read-only.

Syntax

ObjSession.RootSystemFolder

Data Type

FaxFolder object

Remarks

The root system folder is controlled by privileges and contains the server's Inbox, Outbox, and Sent Items.

If the current user is not a 'FACSys Administrator,' access to the root system folder will be denied.

Back to Top

ServerName Property

The ServerName property returns the server name to which the session is connected. Read-only.

Syntax

ObjSession.ServerName

Data Type

String

Back to Top

User Property

The User property returns a FaxUser object and all of its properties. Read-only.

Syntax

ObjSession.User

Data Type

FaxUser object

Back to Top

UserID Property

The UserID property returns the unique 32-bit identifier that identifies the FaxUser for which the session was established (the logged on user). Read-only.

Syntax

ObjSession.UserID

Data Type

Long

Back to Top

UserName Property

The UserName property returns the UserName property (alias) assigned to the current FaxUser object. Read-only.

Syntax

ObjSession.UserName

Data Type

String

Back to Top

Users Property

The Users property returns a FaxUsers collection object. Read-only.

Syntax

ObjSession.Users

Data Type

FaxUsers object

Back to Top

Version Property

The Version property returns the current version of the Active Fax Messaging runtime DLL (fxmgs32.dll). Read-only.

Syntax

ObjSession.Version

Data Type

String

Back to Top