cmdFileOutput

ジャンプ先: 概要. 戻り値. フラグ. Python 例.

概要

cmdFileOutput([close=uint], [closeAll=boolean], [open=string], [status=uint])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。

cmdFileOutput は、取り消し可能、照会可能、および編集不可能です。

Maya が起動してすぐログを開始にするために、起動する前に環境変数 MAYA_CMD_FILE_OUTPUT を指定することもできます。ファイル名に MAYA_CMD_FILE_OUTPUT を設定すると、ファイルが作成され、指定されたファイルに出力されます。Maya の起動後に記述子にアクセスする場合は、-query フラグと -open フラグを同時に使用します。

戻り値

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
close(c)	uint
指定した記述子に対応するファイルを閉じます。ファイルが存在しなければ、-3 が返されます。エラーの場合 -1、正常に閉じたら 0 が返されます。
closeAll(ca)	boolean
開いているファイルをすべて閉じます。
open(o)	string
指定した書き込み用のファイルを開きます(書き込み可能な該当するファイルがあれば、上書きされます)。正常に開けば、値が返されてステータスが照会されファイルが閉じます。ファイルを開いて書き込むことができない場合、-1 が返されます。-open フラグは、照会モードでも指定できます。照会モードでは、指定ファイルが開いている場合はその記述子が、開いていない場合は -1 が返されます。この方法を使用すると、特定のファイルが開いているかどうかを簡単に確認できます。 照会モードでは、このフラグに値が必要になります。
status(s)	uint
指定した記述子のステータスを照会します。該当するファイルがなければ -3 が、ファイルが開かなければ -2 が、エラーが発生すれば -1 が、ファイルが書き込みできる状態であれば 0 が返されます。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

cmds.cmdFileOutput( o='dbOutput.txt' )
# Result: 1 #
print( 'This message is in the file\n' )
# This message is in the file
cmds.cmdFileOutput( s=1 )
# Result: 0 #
cmds.cmdFileOutput( s=2 )
# Result: -3 #
cmds.cmdFileOutput( c=1 )
# Result: 0 #
# Notice that the 'This message is in the file' string is in the file,
# as are all of the entered commands and the
# '# Result: ...' lines, etc.

# Turn on logging to a file on Maya startup so as to log all error
# messages which happen on startup.
#
# Set the environment variable MAYA_CMD_FILE_OUTPUT to "trace.txt"
# Start up Maya
# Messages should now be logged to the file "trace.txt" as well as the
# script editor window.

# Turn off logging to the filename specified by $MAYA_CMD_FILE_OUTPUT
# after Maya has completed startup.
#
import os
traceFile = os.environ[ "MAYA_CMD_FILE_OUTPUT" ]
descriptor = cmds.cmdFileOutput( q=True, o=traceFile )
if -1 != descriptor:
	cmds.cmdFileOutput( close=descriptor )