Functions COM オブジェクト メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
サポート オートメーション自動タスクでは、以下の Functions COM オブジェクト メソッドを使用することができます。
関数
説明
B64Encode (BSTR data, VARIANT *varResult)
指定されたデータを Base64 でエンコードします。
B64Decode (BSTR data, VARIANT *varResult)
指定されたデータをデコードします。
CheckIfServerExists (BSTR URL, USHORT port, VARIANT *varResult)
指定されたサーバに対するリクエストを行って、サーバが接続を受け入れているかどうかを判別します。
Eof (LONG fileno, VARIANT *varResult)
指定されたテキスト ファイルに未読データがあるかどうかを判別します。
EscalateToLive (VARIANT *varResult)
顧客セッションを Self-Service からライブ セッションにエスカレートします。
ExecuteRC (BSTR MethodName, BSTR ParamStr, int ParamCount, VARIANT *varResult)
サーバ上で RuleConduit 呼び出しを実行して、任意のサーバ メソッドの実行を許可します。
ExecuteWaitAndCaptureStream (BSTR strProg, int nStream, VARIANT *varResult)
指定されたコマンドを実行して、プロセスが終了するまで待機し、プロセス実行から出力を収集します。
FileAddAttributes (BSTR szFilePath, LONG dwAttr, VARIANT *bvarResult)
すでに存在する属性を変更せずに、属性(読み取り専用、圧縮済み、アーカイブ済みなど)をファイルに追加する場合に呼び出します。
FileCloseTextFile (LONG fileno)
FileCreateTextFile または FileOpenTextFile によって事前にオープンされたテキスト ファイルをクローズします。
FileCopyTo (BSTR szSourceFilePath, BSTR szDestFilePath, VARIANT_BOOL bcanOverwrite, VARIANT *bvarResult)
2 つの場所の間でファイルをコピーする場合に FileCopyTo を呼び出します。
FileCreateTextFile (BSTR szFilePath, BOOL overwrite, VARIANT *varResult)
指定されたロケーションに新規のテキスト ファイルを作成し、そのファイルと対話する場合に使用できるハンドルを返します。
FileDelete (BSTR szFilePath, VARIANT *bvarResult)
ファイルを永久に削除する場合に呼び出します。
FileExecute (BSTR szCommand, VARIANT *bvarResult)
ファイルを実行する場合に呼び出します。
FileExecuteAndWait (BSTR szCommand, LONG dwMilliseconds, VARIANT *bvarResult)
ファイルを実行し、実行が終了するまで待機する場合に呼び出します。
FileExists (BSTR szFilePath, VARIANT *bvarResult)
ファイルが存在するかどうかを確認します。
FileGetAttributes (BSTR szFilePath, VARIANT *dwvarResult)
ファイルの属性(読み取り専用、アーカイブ済み、圧縮済みなど)を取得する場合に呼び出します。
FileGetDirectoryContents (BSTR pathName, BOOL showFiles, BOOL showDirs, VARIANT *varResult)
指定されたディレクトリの選択されたコンテンツが返されます。
FileGetDrives (VARIANT *varResult)
マウントされているドライブのリストを取得する場合に呼び出します。
FileGetDriveType (BSTR driveName, VARIANT *varResult)
指定されたドライブのタイプを返します。
FileGetInfo (BSTR szFilePath, VARIANT *varResult)
ファイルのサイズおよび日付の情報を取得する場合に呼び出します。
FileGetINISectionContents (BSTR filename, BSTR sectionName, VARIANT *varResult)
指定された INI セクションのコンテンツのパイプ区切りリストを取得します。
FileGetINIValue (BSTR fileName, BSTR sectionName, BSTR keyName, BSTR defaultValue, VARIANT *varResult)
INI ファイル内の指定された項目の値を取得します。
FileGetInternetFile (BSTR szURL, BSTR szFilePath, VARIANT *bvarResult)
インターネットからファイルをダウンロードする場合に呼び出します。
FileGetSize (BSTR szPath, VARIANT *varResult)
ファイルのサイズ(バイト単位)を取得します。
FileGetVersion (BSTR szFilePath, VARIANT *szvarResult)
ファイルのバージョン番号を取得します。
FileGetVolumeInfo (BSTR szVolumeRootPath, VARIANT *varResult)
ドライブの情報を取得します。
FileMakeDir (BSTR szDirPath, VARIANT *bvarResult)
ディレクトリを作成します。
FileMoveTo (BSTR szSourceFilePath, BSTR szDestFilePath, VARIANT_BOOL bcanOverwrite, VARIANT *bvarResult)
2 つの場所の間でファイルを移動します。
FileOpenTextFile (BSTR szFilePath, BSTR szMode, VARIANT *varResult)
指定されたテキスト ファイルを開き、そのファイルと対話する場合に使用できるハンドルを返します。
FileReadLine (LONG fileno, VARIANT *varResult)
テキスト ファイルから 1 行のテキストを読み取ります。
FileRecycle (BSTR szFilePath, VARIANT *bvarResult)
ファイルをリサイクルします。 リサイクルにより、ファイルはリサイクル ビンに格納されて、元のフォルダから除去されます。
FileRenameTo (BSTR szSourceFilePath, BSTR szDestFilePath, VARIANT_BOOL bcanOverwrite, VARIANT *bvarResult)
ファイルの名前を変更する場合に FileRenameTo を呼び出します。
FileSetAttributes (BSTR szFilePath, LONG dwAttr, VARIANT *bvarResult)
ファイルの属性(読み取り専用、アーカイブ済み、圧縮済みなど)を設定します。
FileSetINIData (BSTR filename, BSTR sectionName, BSTR keyName, BSTR data, VARIANT *varResult)
指定されたキーに対するデータを INI ファイルに設定します。
FileWriteLine (LONG fileno, BSTR value, VARIANT *varResult)
1 行のテキストをテキスト ファイルに書き込みます。
GetChildWindowCaption (int index, VARIANT *varResult)
指定された子ウィンドウのタイトルを取得します。
GetChildWindowHandle (int index, VARIANT *varResult)
指定された子ウィンドウのハンドルを取得します。
GetChildWindowProcessName (int index, VARIANT *varResult)
指定された子ウィンドウを所有するプロセスの名前を取得します。
GetChildWindows (int hwnd, VARIANT *varResult)
指定されたウィンドウの子であるウィンドウを列挙して、今後のクエリ実行の結果を保存し、その数を返します。
GetExecutionEnvironment (VARIANT *varResult)
スクリプトがどこで実行されているかを示す文字列を取得します。
GetLocalization (VARIANT *varResult)
現在のユーザのローカライゼーションを取得します。
GetRootUrl (VARIANT *result)
サーバ ルート URL を返します。
GetStaticContentUrl (VARIANT *result)
サーバ静的コンテンツ URL を返します。
GetStaticItemURL (BSTR itemGuid, VARIANT *varResult)
所定の静的コンテンツのルート URL を取得します。
GetSupportDeskOpen (VARIANT *varResult)
サポート デスクの営業時間ステータスを取得します。
GetWindowCaption (int index, VARIANT *varResult)
指定されたウィンドウのタイトルを取得します。
GetWindowHandle (int index, VARIANT *varResult)
指定されたウィンドウのハンドルを取得します。
GetWindowProcessName (int index, VARIANT *varResult)
指定されたウィンドウを所有するプロセスの名前を取得します。
GetWindows (VARIANT *varResult)
システムの最上位ウィンドウのハンドルを列挙して、今後の呼び出しの結果を保存し、その数を返します。
HttpGet (BSTR szUrl, VARIANT *varResult)
指定された URL に対するリクエストを行って、結果を返します。
HttpPost (BSTR szUrl, BSTR szBody)
指定されたリクエスト本文を指定された URL にポストします。
InternetCheckConnection (VARIANT *varResult)
顧客マシンがインターネットに接続中かどうかを判別します。
LogMessage (BSTR szMessage)
スクリプト実行用のセッション ログにメッセージを追加します。
OutlookGetPSTContents (BSTR szPSTPath, VARIANT *varResult)
指定された Outlook PST ファイルのコンテンツを取得します。
PromptUser (LONG Timeout, BOOL DefaultResult, BSTR Message, VARIANT *varResult)
ユーザに所定のメッセージをプロンプトで表示します。
ReadLine (LONG fileno, VARIANT *varResult)
テキスト ファイルから 1 行のテキストを読み取ります。 (これは廃止されたので、代わりに FileReadLine を使用してください)。
RegCopyKey (BSTR szSourceRoot, BSTR szSourceKey, BSTR szDestRoot, BSTR szDestKey, VARIANT_BOOL bCanOverwrite, VARIANT *varResult)
1 つのキーのコンテンツ全体を別のキーにコピーします。
RegCopyValue (BSTR szSourceRoot, BSTR szSourceKey, BSTR szSourceValue, BSTR szDestRoot, BSTR szDestKey, BSTR szDestValue, VARIANT *bvarResult)
1 つのキー/値のコンテンツを別のキー/値にコピーします。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegCreateKey (BSTR szRootPath, BSTR szKeyPath, VARIANT *bvarResult)
ユーザのレジストリにキー エントリを作成します。
RegDeleteKey (BSTR szRootPath, BSTR szKeyPath, VARIANT *bvarResult)
レジストリからキーを削除します。 ユーザに、指定されたルートからキーを削除するための権限が必要です。
RegDeleteValue (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, VARIANT *bvarResult)
レジストリからキー値を削除します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetDWORD (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, VARIANT *dwvarResult)
レジストリ内の指定されたキーから DWORD 値を取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetString (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, VARIANT *szvarResult)
レジストリ キーから文字列値を取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetSubkeyByIndex (BSTR szRoot, BSTR szKey, LONG idxSubkey, VARIANT *varResult)
インデックスに基づいてサブキーの名前を取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetSubkeysCount (BSTR szRoot, BSTR szKey, VARIANT *varResult)
所定のキーの下にあるキーの数を取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetValueByIndex (BSTR szRoot, BSTR szKey, LONG idxValue, VARIANT *varResult)
インデックスに基づいてキーの値を取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetValuesCount (BSTR szRoot, BSTR szKey, VARIANT *varResult)
所定のキーの値の数を取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegGetValueType (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, VARIANT *dwvarResult)
所定のレジストリ キーに対する値のタイプを取得します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegKeyExists (BSTR szRootPath, BSTR szKeyPath, VARIANT *bvarResult)
レジストリからキーのクエリを実行します。 ユーザに、指定されたルートからキーのクエリを実行するための権限が必要です。
RegMoveKey (BSTR szSourceRoot, BSTR szSourceKey, BSTR szDestRoot, BSTR szDestKey, VARIANT_BOOL bCanOverwrite, VARIANT *varResult)
1 つのキーのコンテンツ全体を別のキーに移動します。
RegMoveValue (BSTR szSourceRoot, BSTR szSourceKey, BSTR szSourceValue, BSTR szDestRoot, BSTR szDestKey, BSTR szDestValue, VARIANT *bvarResult)
1 つのキー値のコンテンツを別のキー値に移動します。 ユーザに、指定されたルートでキーのクエリを実行して宛先に書き込むための権限が必要です。
RegRenameValue (BSTR szRootPath, BSTR szKeyPath, BSTR szOldValueName, BSTR szNewValueName, VARIANT *bvarResult)
レジストリ値の名前を変更します。 注: ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegRestoreKeyFromFile (BSTR szRootPath, BSTR szKeyPath, BSTR szFilePath, VARIANT *bvarResult)
キーのコンテンツ全体をファイルからレジストリに復元します。 ユーザに、指定されたルートでキーのクエリおよび書き込みを行うための権限が必要です。
RegSaveKeyToFile (BSTR szRootPath, BSTR szKeyPath, BSTR szFileName, VARIANT *bvarResult)
キーのコンテンツ全体をレジストリからファイルに保存します。 このファイルは、後で RegRestoreKeyFromFile を使用して復元することができます。 ユーザに、指定されたルートからキーのクエリを実行するための権限が必要です。
RegSetDWORD (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, LONG dwValue, VARIANT *bvarResult)
レジストリに DWORD 値を設定します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegSetString (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, BSTR szValue, VARIANT *bvarResult)
レジストリにキーの文字列値を設定します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RegValueExists (BSTR szRootPath, BSTR szKeyPath, BSTR szValueName, VARIANT *bvarResult)
レジストリにキー/値のペアが存在するかどうかを確認します。 ユーザに、指定されたルートでキーのクエリを実行するための権限が必要です。
RunCommandAsImpersonatedUser (BSTR bapp, BSTR bargs, VARIANT_BOOL block, LONG timeout, VARIANT *varResult)
スクリプトが持っている同じ認証情報で、アプリケーションを実行します(廃止)。 成功の場合は 0 が返されます。
RunCommandAsUser (BSTR domain, BSTR user, BSTR password, BSTR app, BSTR args, VARIANT_BOOL block, LONG timout, VARIANT *varResult)
別のユーザとしてアプリケーションを実行します。 成功の場合は 0 が返されます。
SaveLog (BSTR fileName)
セッション ログを保存します。
SendEmail (BSTR toAddress, BSTR emailSubject, BSTR emailBody)
CA Service Desk Manager のメール デーモンを介して電子メールを送信します。
SetAcquiredData (BSTR data)
後で使用できるように、スクリプト固有の一連の文字データをサーバに保存します。
SetScriptSuccess (BOOL bSuccess, VARIANT *varResult)
スクリプトの観点から、スクリプトが正常に実行されたかどうかを示します。
ShowFileBrowseDlg (BSTR browseType, BSTR fileExt, VARIANT *varResult)
標準の Windows ファイル参照ダイアログ ボックスを表示して、選択されたファイルを返します。
ShowMessage (BSTR szMessage)
ユーザに対するメッセージをメッセージ ボックスに表示します。
Sleep (LONG time)
実行スレッドをスリープさせます。
TransferToQueue (BSTR queueID, BSTR queueName)
顧客の現在のキューを設定します。これは、顧客が、ライブにエスカレートされた場合に入るキューです。
UtilAttachDll (BSTR szDllPath, BSTR szHTTPLocation, VARIANT *varResult)
dll をプロセス スペースにロードして、関数をそこから呼び出すことができるようにします。
UtilCloseTask (BSTR szProcName, VARIANT *bvarResult)
実行中のタスクをクローズします。
UtilDetachDll (LONG idDll, VARIANT *varResult)
メモリから DLL をアンロードします。
UtilEndProcess (BSTR szProcName, VARIANT *bvarResult)
指定された名前のプロセスを終了します。
UtilExitWindows (LONG lAction, VARIANT_BOOL bForce, VARIANT_BOOL bRelogin)
ログオフ、再起動、またはシャットダウンのいずれかによって、Windows を終了します。
UtilExternalMethodCall (LONG idDll, BSTR szFuncName, LONG lFuncType, BSTR szParams, VARIANT *varResult)
ロードされた DLL から関数を実行します。
UtilGetComputerName (VARIANT *varResult)
現在のコンピュータ名を取得します。
UtilGetEnvironmentVariable (BSTR szVarName, VARIANT *varResult)
定義済みの環境変数の値を取得します。
UtilGetOSVersion (VARIANT *varResult)
OS バージョンを取得します。
UtilGetProcessByIndex (LONG idxProcess, VARIANT *varResult)
指定されたプロセスのプロセス情報を取得します。
UtilGetProcesses (VARIANT *varResult)
顧客マシン上で実行中のすべてのプロセスのリストを取得します。
UtilGetProcessesCount (VARIANT *varResult)
顧客マシン上で現在実行中のプロセスの数を取得します。
UtilGetProcessMemory (LONG processID, VARIANT *varResult)
指定されたプロセスで使用されているメモリの容量を取得します。
UtilGetRunningTask (LONG idxWnd, VARIANT *varResult)
顧客マシン上で実行中のタスクに関連する情報を取得します。 最初に UtilGetRunningTasksCount を呼び出して、使用可能なタスクの数を判別する必要があります。
UtilGetRunningTasksCount (VARIANT *varResult)
顧客マシン上で実行中のタスクの数を取得します。
UtilGetSystemDir (VARIANT *varResult)
Windows システム ディレクトリを取得します。
UtilGetSystemMetrics (LONG nIndex, VARIANT *varResult)
指定されたシステム メトリックの値を取得します。
UtilGetUserName (VARIANT *varResult)
ユーザのログオン名を取得します。
UtilGetWindowsDir (VARIANT *varResult)
Windows 用ディレクトリを取得します。
UtilGlobalMemoryStatus (VARIANT *varResult)
グローバル メモリの可用性に関する情報を取得します。
WScript
多くのパブリック ドメイン スクリプト例が Microsoft TechNet ScriptCenter などのソースから利用できますが、通常はシステム管理者向けに用意されています。ただし、多くは自動タスクで使うと便利です。 これらのスクリプト例では、WScript と呼ばれるオブジェクトがあるものとして記述されています。このオブジェクトは、Microsoft がコマンドライン スクリプト実行エンジンの一部として提供しているもので、Windows Script Host 自体には含まれていません。
CA SDM は、Echo、Sleep、GetObject、CreateObject メソッドを提供する WScript オブジェクトのシンプルなバージョンを実装しており、一般的によく使われる WScript メソッドとの互換性が確保されています。 WScript.Echo() は、通常はコマンドラインへの書き込みを行いますが、CA SDM では自動タスク ログに書き込むように実装されています。このため、WScript.Echo() は Functions.LogMessage() と同じです。