Win32 API 日本語リファレンス
ホーム › NetworkManagement.NetManagement › NetScheduleJobAdd

NetScheduleJobAdd

関数
スケジュールキューに新しいジョブを追加する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// NETAPI32.dll
#include <windows.h>

DWORD NetScheduleJobAdd(
    LPCWSTR Servername,
    BYTE* Buffer,
    DWORD* JobId
);

パラメーター

名前型方向説明
ServernameLPCWSTRin関数を実行するリモート サーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカル コンピューターが使用されます。
BufferBYTE*inout登録するジョブを記述する AT_INFO 構造体へのポインターです。さまざまなジョブ プロパティを使用したジョブのスケジュール設定について詳しくは、以下の「解説」セクションおよび Network Management Function Buffers を参照してください。
JobIdDWORD*inout新しく登録されたジョブのジョブ識別子を受け取るポインターです。このエントリは、関数が正常に終了した場合にのみ有効です。

戻り値の型: DWORD

公式ドキュメント

NetScheduleJobAdd 関数は、指定した将来の日時に実行するジョブを登録します。この関数を使用するには、ジョブの登録先となるコンピューターでスケジュール サービスが開始されている必要があります。

戻り値

関数が成功した場合、戻り値は NERR_Success です。

関数が失敗した場合、戻り値はシステム エラー コードです。エラー コードの一覧については、 System Error Codes を参照してください。

解説(Remarks)

通常、スケジュール ジョブの追加先となるコンピューターのローカル Administrators グループのメンバーのみが、この関数を正常に実行できます。Servername パラメーターが指す文字列で渡されるサーバー名がリモート サーバーの場合は、そのリモート サーバーのローカル Administrators グループのメンバーのみがこの関数を正常に実行できます。

次のレジストリ値の最下位ビットが設定されている場合 (たとえば 0x00000001)、Server Operators グループに属するユーザーもこの関数を正常に実行できます。

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

以下は、 NetScheduleJobAdd 関数がサポートするさまざまなプロパティを使用してジョブをスケジュールする例です。

一度だけ実行するジョブをスケジュールするには:

ジョブは、Buffer パラメーターが指す AT_INFO 構造体の JobTime メンバーで指定された時刻に実行されます。ジョブの実行後、ジョブは削除されます。

複数回実行された後に削除されるジョブをスケジュールするには:

注 AT_INFO 構造体の DaysOfMonth メンバーと DaysOfWeek メンバーの両方を設定する必要はありません。
ジョブは、Buffer パラメーターが指す AT_INFO 構造体の JobTime メンバーで指定された時刻に、 AT_INFO 構造体の DaysOfMonth メンバーまたは DaysOfWeek メンバーで設定された各日について 1 回ずつ実行されます。各ジョブの実行後、対応するビットがクリアされます。最後のビットがクリアされると、ジョブは削除されます。

定期的に実行するジョブをスケジュールするには:

注 AT_INFO 構造体の DaysOfMonth メンバーと DaysOfWeek メンバーの両方を設定する必要はありません。
ジョブは、Buffer パラメーターが指す AT_INFO 構造体の JobTime メンバーで指定された時刻に、 AT_INFO 構造体の DaysOfMonth メンバーまたは DaysOfWeek メンバーで設定された各日について定期的に実行されます。繰り返しの実行によってジョブが削除されることはありません。ジョブを削除する唯一の方法は、 NetScheduleJobDel 関数を明示的に呼び出すことです。

DaysOfWeek、DaysOfMonth、およびジョブ プロパティのビットマスクの説明については、 AT_INFO 構造体を参照してください。

Windows 2000 では、従来の AT サービスとタスク スケジューラが統合されました。タスク スケジューラ サービスの精度は分単位のみでした。そのため、NetScheduleJobAdd 関数は、ジョブの実行をスケジュールする際に AT_INFO 構造体の JobTime メンバーで指定された時と分のみを使用します。

Windows Vista 以降では、タスク スケジューラの精度が秒単位に向上しました。そのため、NetScheduleJobAdd 関数は、ジョブの実行をスケジュールする際に AT_INFO 構造体の JobTime メンバーで指定された時、分、秒のみを使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// NETAPI32.dll
#include <windows.h>

DWORD NetScheduleJobAdd(
    LPCWSTR Servername,
    BYTE* Buffer,
    DWORD* JobId
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetScheduleJobAdd(
    [MarshalAs(UnmanagedType.LPWStr)] string Servername,   // LPCWSTR
    IntPtr Buffer,   // BYTE* in/out
    ref uint JobId   // DWORD* in/out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetScheduleJobAdd(
    <MarshalAs(UnmanagedType.LPWStr)> Servername As String,   ' LPCWSTR
    Buffer As IntPtr,   ' BYTE* in/out
    ByRef JobId As UInteger   ' DWORD* in/out
) As UInteger
End Function
' Servername : LPCWSTR
' Buffer : BYTE* in/out
' JobId : DWORD* in/out
Declare PtrSafe Function NetScheduleJobAdd Lib "netapi32" ( _
    ByVal Servername As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByRef JobId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetScheduleJobAdd = ctypes.windll.netapi32.NetScheduleJobAdd
NetScheduleJobAdd.restype = wintypes.DWORD
NetScheduleJobAdd.argtypes = [
    wintypes.LPCWSTR,  # Servername : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* in/out
    ctypes.POINTER(wintypes.DWORD),  # JobId : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetScheduleJobAdd = Fiddle::Function.new(
  lib['NetScheduleJobAdd'],
  [
    Fiddle::TYPE_VOIDP,  # Servername : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* in/out
    Fiddle::TYPE_VOIDP,  # JobId : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetScheduleJobAdd(
        Servername: *const u16,  // LPCWSTR
        Buffer: *mut u8,  // BYTE* in/out
        JobId: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetScheduleJobAdd([MarshalAs(UnmanagedType.LPWStr)] string Servername, IntPtr Buffer, ref uint JobId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetScheduleJobAdd' -Namespace Win32 -PassThru
# $api::NetScheduleJobAdd(Servername, Buffer, JobId)
#uselib "NETAPI32.dll"
#func global NetScheduleJobAdd "NetScheduleJobAdd" sptr, sptr, sptr
; NetScheduleJobAdd Servername, varptr(Buffer), varptr(JobId)   ; 戻り値は stat
; Servername : LPCWSTR -> "sptr"
; Buffer : BYTE* in/out -> "sptr"
; JobId : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "NETAPI32.dll"
#cfunc global NetScheduleJobAdd "NetScheduleJobAdd" wstr, var, var
; res = NetScheduleJobAdd(Servername, Buffer, JobId)
; Servername : LPCWSTR -> "wstr"
; Buffer : BYTE* in/out -> "var"
; JobId : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD NetScheduleJobAdd(LPCWSTR Servername, BYTE* Buffer, DWORD* JobId)
#uselib "NETAPI32.dll"
#cfunc global NetScheduleJobAdd "NetScheduleJobAdd" wstr, var, var
; res = NetScheduleJobAdd(Servername, Buffer, JobId)
; Servername : LPCWSTR -> "wstr"
; Buffer : BYTE* in/out -> "var"
; JobId : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetScheduleJobAdd = netapi32.NewProc("NetScheduleJobAdd")
)

// Servername (LPCWSTR), Buffer (BYTE* in/out), JobId (DWORD* in/out)
r1, _, err := procNetScheduleJobAdd.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Servername))),
	uintptr(Buffer),
	uintptr(JobId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetScheduleJobAdd(
  Servername: PWideChar;   // LPCWSTR
  Buffer: Pointer;   // BYTE* in/out
  JobId: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetScheduleJobAdd';
result := DllCall("NETAPI32\NetScheduleJobAdd"
    , "WStr", Servername   ; LPCWSTR
    , "Ptr", Buffer   ; BYTE* in/out
    , "Ptr", JobId   ; DWORD* in/out
    , "UInt")   ; return: DWORD
●NetScheduleJobAdd(Servername, Buffer, JobId) = DLL("NETAPI32.dll", "dword NetScheduleJobAdd(char*, void*, void*)")
# 呼び出し: NetScheduleJobAdd(Servername, Buffer, JobId)
# Servername : LPCWSTR -> "char*"
# Buffer : BYTE* in/out -> "void*"
# JobId : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn NetScheduleJobAdd(
    Servername: [*c]const u16, // LPCWSTR
    Buffer: [*c]u8, // BYTE* in/out
    JobId: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
proc NetScheduleJobAdd(
    Servername: WideCString,  # LPCWSTR
    Buffer: ptr uint8,  # BYTE* in/out
    JobId: ptr uint32  # DWORD* in/out
): uint32 {.importc: "NetScheduleJobAdd", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetScheduleJobAdd(
    const(wchar)* Servername,   // LPCWSTR
    ubyte* Buffer,   // BYTE* in/out
    uint* JobId   // DWORD* in/out
);
ccall((:NetScheduleJobAdd, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt8}, Ptr{UInt32}),
      Servername, Buffer, JobId)
# Servername : LPCWSTR -> Cwstring
# Buffer : BYTE* in/out -> Ptr{UInt8}
# JobId : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetScheduleJobAdd(
    const uint16_t* Servername,
    uint8_t* Buffer,
    uint32_t* JobId);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetScheduleJobAdd(Servername, Buffer, JobId)
-- Servername : LPCWSTR
-- Buffer : BYTE* in/out
-- JobId : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetScheduleJobAdd = lib.func('__stdcall', 'NetScheduleJobAdd', 'uint32_t', ['str16', 'uint8_t *', 'uint32_t *']);
// NetScheduleJobAdd(Servername, Buffer, JobId)
// Servername : LPCWSTR -> 'str16'
// Buffer : BYTE* in/out -> 'uint8_t *'
// JobId : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetScheduleJobAdd: { parameters: ["buffer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetScheduleJobAdd(Servername, Buffer, JobId)
// Servername : LPCWSTR -> "buffer"
// Buffer : BYTE* in/out -> "pointer"
// JobId : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetScheduleJobAdd(
    const uint16_t* Servername,
    uint8_t* Buffer,
    uint32_t* JobId);
C, "NETAPI32.dll");
// $ffi->NetScheduleJobAdd(Servername, Buffer, JobId);
// Servername : LPCWSTR
// Buffer : BYTE* in/out
// JobId : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
    int NetScheduleJobAdd(
        WString Servername,   // LPCWSTR
        byte[] Buffer,   // BYTE* in/out
        IntByReference JobId   // DWORD* in/out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetScheduleJobAdd = NetScheduleJobAdd(
    Servername : UInt16*,   # LPCWSTR
    Buffer : UInt8*,   # BYTE* in/out
    JobId : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetScheduleJobAddNative = Uint32 Function(Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
typedef NetScheduleJobAddDart = int Function(Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
final NetScheduleJobAdd = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetScheduleJobAddNative, NetScheduleJobAddDart>('NetScheduleJobAdd');
// Servername : LPCWSTR -> Pointer<Utf16>
// Buffer : BYTE* in/out -> Pointer<Uint8>
// JobId : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetScheduleJobAdd(
  Servername: PWideChar;   // LPCWSTR
  Buffer: Pointer;   // BYTE* in/out
  JobId: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetScheduleJobAdd';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetScheduleJobAdd"
  c_NetScheduleJobAdd :: CWString -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- Servername : LPCWSTR -> CWString
-- Buffer : BYTE* in/out -> Ptr Word8
-- JobId : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netschedulejobadd =
  foreign "NetScheduleJobAdd"
    ((ptr uint16_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* Servername : LPCWSTR -> (ptr uint16_t) *)
(* Buffer : BYTE* in/out -> (ptr uint8_t) *)
(* JobId : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetScheduleJobAdd" net-schedule-job-add :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPCWSTR
  (buffer :pointer)   ; BYTE* in/out
  (job-id :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetScheduleJobAdd = Win32::API::More->new('NETAPI32',
    'DWORD NetScheduleJobAdd(LPCWSTR Servername, LPVOID Buffer, LPVOID JobId)');
# my $ret = $NetScheduleJobAdd->Call($Servername, $Buffer, $JobId);
# Servername : LPCWSTR -> LPCWSTR
# Buffer : BYTE* in/out -> LPVOID
# JobId : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目