vl-doc-export (AutoLISP)

関数を現在のドキュメントで使用可能にします。

サポートされているプラットフォーム: Windows のみ

構文と要素

(vl-doc-export 'function)

'function

タイプ: サブルーチン

書き出す関数名のシンボル。

戻り値

タイプ: T

常に T を返します。

注意

vl-doc-export 関数を VLX 独自の名前空間で実行する VLX から呼び出すと、VLX をロードするいずれかのドキュメントの名前空間に指定した関数が書き出されます。

vl-doc-export 関数は、ファイルのトップ レベルで使用しなければなりません。他のフォーム内(defun 内など)では、決して使用しないでください。

例

次のコードは、kertrats.lsp という名前のファイルの内容を示しています。このファイルは、独自の名前空間で実行される VLX にコンパイルされています。VLX ファイルの名前は、kertrats.vlx です。vldoc-export 関数呼び出しにより、kertrats.vlx をロードしたすべてのドキュメントから kertrats 関数が使用できるようになります。

(vl-doc-export 'kertrats)
(defun kertrats ()
  (princ "This function goes nowhere") 
)