|
AccMonitor
API
Reference -
AccMntr
Library
Objects
for complete
information
and sample
code, syntax
to all
methods
please refer
to the SDK
MonitorConsole
IMonitorConsole
Main OLE
Automation
Object for
the
AccMonitor
Console.
MonitorConsole
Properties
|
Property
Name |
R / W |
Type |
Description |
|
RunQueueList |
R |
OleVariant |
Returns
a string
with the
list of
entries
in the
Run
Queue.
Entries
are
separated
by a
CR/LF
pair and
each
entry is
a CSV
List of
four
values.
The
fields
are:
-
Web
Name
-
Text
description
of Run
Type
-
Run
Status
-
Numeric
Value
of Run
Type
|
|
EnableLogging |
R / W |
WordBool |
Returns
or Sets
the
boolean
value of
the
Enable
Logging
setting.
TRUE =
Logging
is
enabled
FALSE =
Logging
is
disabled |
|
NewFilesOnly |
R / W |
WordBool |
Returns
or Sets
the
setting:
Verify
New
Pages
Only /
Refresh
All
Pages
TRUE =
Verify
New
Pages
Only
FALSE =
Refresh
All
Pages |
|
FailedReportsOnly |
R / W |
WordBool |
Returns
or Sets
the
boolean
value of
the
setting:
Generate
Failed
Reports
Only
TRUE =
Setting
is on
FALSE =
Setting
is off |
|
CrawlerIgnoreDynamic |
R / W |
WordBool |
Returns
or Sets
the
boolean
value of
the
crawler
setting:
Ignore
Dynamic
Links
when
Crawling
TRUE =
Setting
is on
FALSE =
Setting
is off |
|
CrawlerTreatAsDir |
R / W |
WordBool |
Returns
or Sets
the
boolean
value of
the
crawler
setting:
Treat
links
without
extensions
as
directories
TRUE =
Setting
is on
FALSE =
Setting
is off |
|
CrawlerSafeMode |
R / W |
WordBool |
Returns
or Sets
the
boolean
value of
the
crawler
setting:
Crawl in
Safe
Mode.
TRUE =
Crawl in
Safe
Mode is
enabled
FALSE =
Crawl in
Safe
Mode is
disabled |
|
ScheduleLogText |
R |
OleVariant |
Returns
a string
with the
text
from the
Schedule
log file
(the
main log
for the
service) |
MonitorConsole
Methods
WebNames
Method
Returns a
string with
the list of
web names
for the
given web
type. Each
Web Name is
separated by
a CR/LF
pair.
WebProperties
Method
Opens the
Web
Definition
screen for
the given
Web Name
WebLogText
Method
Returns a
string with
the text
from the log
file for the
given Web
Name. An
empty (null)
string will
be returned
if the web
has not been
run or if
the log file
does not
exist.
CreateWeb
Method
Creates a
Web
definition
with the
given Web
Name of the
given
WebType
using the
given
parameters.
Returns True
if the web
is created
and False if
it is not.
This method
will fail if
there are
not enough
web licenses
to create a
new web.
DeleteWeb
Method
Automates
selecting
the given
Web Name in
the console
and calling
the Delete
Web action.
This will
return true
if the web
is
successfully
deleted or
if the web
does not
appear in
the console.
WebInRunQueue
Method
Checks to
see if the
given
WebName is
the Run
Queue for
the given
RunType.
This will
return true
if the given
WebName is
the Run
Queue for
the given
RunType and
false if it
is not.
RunWeb
Method
Tries to add
the given
WebName to
the Run
Queue for
the ‘Run
Web’ run
type (100).
PublishWebReports
Method
Tries to add
the given
WebName to
the Run
Queue for
the ‘Publish
Web’ run
type (10).
PublishWebEarl
Method
Tries to add
the given
WebName to
the Run
Queue for
the ‘Publish
Web to EARL’
run type
(11).
ExportWeb
Method
Tries to add
the given
WebName to
the Run
Queue for
the ‘Export
Web to
History’ run
type (1).
ExportWebAndPurge
Method
Tries to add
the given
WebName to
the Run
Queue for
the ‘Export
Web to
History and
Purge’ run
type (2).
OpenSchedule
Method
Opens the
Autorun
Scheduler
screen
ScheduleWeb
Method
Tries to
schedule the
given
WebName for
the given
RunType
using the
RunInterval,
RunTime and
RunDay
parameters.
If the
WebName is
already
scheduled
for the
given
RunType and
UpdateExisting
is true then
the schedule
entry is
updated with
the
RunInterval,
RunTime and
RunDay
parameters.
ProxySettings
Method
Opens the
Proxy
Settings
screen
SMTPSettings
Method
Opens the
SMTP
Settings
screen
DatabaseSizeSettings
Method
Opens the
Database
Size
Settings
screen
MaxFileSizeSettings
Method
Opens the
Maximum File
Size
Settings
screen
SummaryReportSettings
Method
Opens the
Summary
Report
Settings
screen
ListEditor
Method
Opens the
List Editor
for the
given List
Type
GlobalAccessibilityChecks
Method
Opens the
Global
Accessibility
Checks
screen
GlobalRecorderSettings
Method
Opens the
Global
Accessibility
Recorder
Settings
screen
GlobalReportSettings
Method
Opens the
Global
Report
Settings
screen
GlobalTableVerificationSettings
Method
Opens the
Global Table
Verification
Settings
screen
GlobalAccRepairOptions
Method
Opens the
Global
AccRepair
Options
screen (if
the
AccRepair
feature
license has
been
installed)
WebBasedAdminManager
Method
Opens the
Web Based
Admin
Management
utility
ShowAbout
Method
Shows the
AccMonitor
About screen
ShowConsole
Method
Shows the
Console
HideConsole
Method
Returns the
Console
screen to
the Tray
Icon state.
NewWeb
Method
Automates
the New Web
action.
This method
will fail if
there are
not enough
web licenses
to create a
new web.
RunQueue
Method
Opens the
Run Queue
screen if
there are
any entries,
otherwise
shows a
message
stating no
entries in
the run
queue.
WebListDetails
Method
Returns a
string
with the
list of
webs and
their
details.
Entries
are
separated
by a CR/LF
pair and
each entry
is has the
following
format:
WebName=CSV
Detail
ScheduleListDetails
Method
Returns a
string
with the
list of
webs and
their
details.
Entries
are
separated
by a CR/LF
pair and
each entry
is has the
following
format:
WebName=CSV
Detail
Printer
Friendly
Version... |
