Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space TSDOC and version E33
Sv translation
languageen

Description

LINKGenerateReport examines all the documents in a database and produces a report.

Syntax

Code Block
languagevb
status = LINKGenerateReport( <SourcePath>, <OutputPath>, <OutputTitle>, <Select>, <Flags> )

Parameters

Parameterinput/OutputTypeDescription
SourcePathInputStringThe path to the databases to be processed. Separate the server and pathname with !!
OutputPathInputStringThe path to the Validator report database. Validator will create this database if it doesn't exist. Separate the server and pathname with !!
OutputTitleInputStringThe title to use if the report database needs to be created.
SelectInputStringUsed to specify the selection formula or view when searching data documents. If you only specify the LINK_VERIFY_DOCUMENTS flag, this parameter should contain a selection formula to select the documents to be processed. If you also specify the LINK_VERIFY_DOCUMENTS_BYVIEW flag, this parameter should be the name of the view that selects the documents.
FlagsInputLongA combination of the LINK_xxx values below.

Flags

FlagDescription
LINK_VERIFY_DOCUMENTSHave Validator run on documents.
LINK_VERIFY_DESIGNHave Validator run on design notes.
LINK_VERIFY_DOCUMENTS_BYVIEWWhen specified with LINK_VERIFY_DOCUMENTS, run on documents selected by a view rather than a selection formula.
LINK_FLAG_REPORT_ALLReport all links, including good ones.
LINK_FLAG_NO_WARNINGSDo not report warnings.
LINK_FLAG_NO_URLSDo not check URLs.
LINK_FLAG_NO_EXTERNAL_LINKSDo not allow links that point to a database other than the current one.
LINK_FLAG_NO_REPL_LOCALDo not search replicas that are not local.
LINK_FLAG_NO_FIELDSDo not check fields.
LINK_FLAG_NO_EMPTY_FIELDSIgnore empty fields.
LINK_FLAGS_DEFAULTUse Validator defaults (no UI, run on documents).
LINK_RUN_SILENTHide the UI.
LINK_IGNORE_CONFLICTSDo not check for save or replication conflicts.

Return Value

Return value
Type
Description
statusLongZero (0) indicates that no error occurred. If the return value is non-zero, use LINKStringLoad to get the error message associated with the error code.

Examples

Code Block
languagevb
status = LINKGenerateReport(
	"myserver!!dbToRun.nsf",_
	"linkreport.nsf",_ 'Database for output report
	"Validator Report",_ 'Title to use if linkreport.nsf needs to be created
	"@ALL",_ 'Selection formula for documents
	LINK_FLAGS_DEFAULT)

 

 

Sv translation
languageja

説明

LINKGenerateReport は、データベース内のすべての文書を検査し、レポートを作成します。

シンタックス

Code Block
languagevb
status = LINKGenerateReport( <SourcePath>, <OutputPath>, <OutputTitle>, <Select>, <Flags> )

パラメータ

パラメータ入力/出力説明
SourcePath入力String処理するノーツデータベースのパス。サーバー名とパス名は !! で区切ります。
OutputPath入力Stringalidator レポートデータベースのパス。指定したデータベースが存在しない場合は、 Validator によって作成されます。サーバー名とパス名は !! で区切ります。
OutputTitle入力Stringレポートデータベースのタイトル。 データベースがすでに存在する場合は、使用されません。
Select入力String

データ文書の検索時に、選択式または ビューを指定するために使用します LINK_VERIFY_DOCUMENTS は、Flags の 1 つとして渡されます 。 LINK_VERIFY_DOCUMENTS フラグのみを指定する場合、このパラメータは、デー タベースでデータ文書を検索するのに使用 する選択式を表します。 LINK_VERIFY_DOCUMENTS_BYVIEW フラグも指定する場合は、このパラメータはデータ文書の検索に使用するビューを表します。

Flags入力Long

下記の LINK_xxx フラグは組み合わせて渡すこともできます。

フラグ

フラグ説明
LINK_VERIFY_DOCUMENTSValidator を文書上で実行します。
LINK_VERIFY_DESIGNValidator を設計ノート上で実行します。
LINK_VERIFY_DOCUMENTS_BYVIEWLINK_VERIFY_DOCUMENTS を指定した場合, 選択式ではなくビューを使用して文書を選択します。
LINK_FLAG_REPORT_ALL

正常なリンクを含め、すべてのリンクを報告 します。

LINK_FLAG_NO_WARNINGS警告を報告しません。
LINK_FLAG_NO_URLSURL を確認しません。
LINK_FLAG_NO_EXTERNAL_LINKS

現在のデータベースを指定しないリンクを許可しません。

LINK_FLAG_NO_REPL_LOCALローカルでないレプリカを検索しません。
LINK_FLAG_NO_FIELDSフィールドを確認しません。
LINK_FLAG_NO_EMPTY_FIELDS空のフィールドを無視します。
LINK_FLAGS_DEFAULTValidator のデフォルトを使用します ( バックグランドで、文書上で実行 )。
LINK_RUN_SILENTバックグランドで実行します。
LINK_IGNORE_CONFLICTS保存または複製時の競合の有無を確認しません。

戻り値

戻り値
説明
statusLong0 は、エラーが発生しなかったことを示します。戻り値が 0 でない場合は、 LINKStringLoad 

を使用して、エラーコードに関連するエラーメッセージを取得してください。

Code Block
languagevb
status = LINKGenerateReport(
	"myserver!!dbToRun.nsf",_
	"linkreport.nsf",_ 'レポートデータベースの指定
	"Validator Report",_ 'レポート使用するタイトル
	"@ALL",_ '文書の選択式
	LINK_FLAGS_DEFAULT)