SysWorks©

SysWorks
Callable Routines Reference Manual
Previous Contents Index

The type values have a symbolic name of the form UFSA$C_type.

By default, STRING is assumed.

log-flags


VMS usage: mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference

Longword of flag bits designating logging behavior. The flags argument is the address of an unsigned longword containing the flag bits. This is an optional argument; if omitted, the default is that all flags are clear.

Description

The SWRK_RENAME_FILE routine ...

See also

SWRK_RENAME_OBJECT

The SWRK_RENAME_OBJECT routine ...

Format

status =SWRK_RENAME_OBJECT(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_RENAME_OBJECT routine ...

See also

SWRK_REPORT_STATISTICS

The SWRK_REPORT_STATISTICS routine ...

Format

status =SWRK_REPORT_STATISTICS(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_REPORT_STATISTICS routine ...

See also

SWRK_RESUME_SERVER

The SWRK_RESUME_SERVER routine ...

Format

status =SWRK_RESUME_SERVER(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_RESUME_SERVER routine ...

See also

SWRK_RETURN_DATE_TIME

The SWRK_RETURN_DATE_TIME routine ...

Format

status =SWRK_RETURN_DATE_TIME(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_RETURN_DATE_TIME routine ...

See also

SWRK_ROLLBACK

The SWRK_ROLLBACK routine ...

Format

status =SWRK_ROLLBACK(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_ROLLBACK routine ...

See also

SWRK_RUN_DETACHED_JOB

The SWRK_RUN_DETACHED_JOB routine ...

Format

status =SWRK_RUN_DETACHED_JOB(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_RUN_DETACHED_JOB routine ...

See also

SWRK_SAVE_DATE_TIME

The SWRK_SAVE_DATE_TIME routine ...

Format

status =SWRK_SAVE_DATE_TIME(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SAVE_DATE_TIME routine ...

See also

SWRK_SCAN_INDEX

The SWRK_SCAN_INDEX routine scans an index.

Format

status =SWRK_SCAN_INDEX(index_root, action_procedure)

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

index_root


VMS usage: structure
type: INDEX_ROOT structure
access: read only
mechanism: by reference

Specifies the address of the index root from which to scan the index elements.

action_procedure


VMS usage: procedure
type: procedure value
access: function call (before return)
mechanism: by value

User-supplied action routine called by SWRK_SCAN_INDEX for each element in the index. The action_procedure must return a success status for SWRK_SCAN_INDEX to continue scanning.

For more information, see "Call Format for an Action Procedure" in the Description section.

Description

The SWRK_SCAN_INDEX routine scans in an index in key order and calls an action procedure for each element found. Calling SWRK_SCAN_INDEX with an empty index root causes no calls to the action procedure.

See also

SWRK_SCAN_LNKLST

The SWRK_SCAN_LNKLST routine ...

Format

status =SWRK_SCAN_LNKLST(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SCAN_LNKLST routine ...

See also

SWRK_SEND_CLIENT_A

The SWRK_SEND_CLIENT_A routine ...

Format

status =SWRK_SEND_CLIENT_A(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SEND_CLIENT_A routine ...

See also

SWRK_SEND_CLIENT

The SWRK_SEND_CLIENT routine ...

Format

status =SWRK_SEND_CLIENT(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SEND_CLIENT routine ...

See also

SWRK_SEND_MAIL

The SWRK_SEND_MAIL routine ...

Format

status =SWRK_SEND_MAIL(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SEND_MAIL routine ...

See also

SWRK_SEND_SERVER_A

The SWRK_SEND_SERVER_A routine ...

Format

status =SWRK_SEND_SERVER_A(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SEND_SERVER_A routine ...

See also

SWRK_SEND_SERVER_MESSAGE_A

The SWRK_SEND_SERVER_MESSAGE_A routine ...

Format

status =SWRK_SEND_SERVER_MESSAGE_A(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SEND_SERVER_MESSAGE_A routine ...

See also

SWRK_SEND_SERVER_MESSAGE

The SWRK_SEND_SERVER_MESSAGE routine ...

Format

status =SWRK_SEND_SERVER_MESSAGE(arg1, [arg2])

RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

arg1


VMS usage: arg1_type
type: integer (unsigned)
access: read only
mechanism: by reference

Specifies arg1...

arg2


VMS usage: arg2_type
type: character string
access: read only
mechanism: by descriptor

Specifies arg2...

Description

The SWRK_SEND_SERVER_MESSAGE routine ...

See also

Previous Next Contents Index