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

NetScheduleJobDel

関数
指定範囲のスケジュール済みジョブをキューから削除する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetScheduleJobDel(
    LPCWSTR Servername,
    DWORD MinJobId,
    DWORD MaxJobId
);

パラメーター

名前方向説明
ServernameLPCWSTRin関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインター。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
MinJobIdDWORDin最小のジョブ識別子。MinJobId より小さいジョブ識別子を持つジョブは削除されません。
MaxJobIdDWORDin最大のジョブ識別子。MaxJobId より大きいジョブ識別子を持つジョブは削除されません。

戻り値の型: DWORD

公式ドキュメント

NetScheduleJobDel 関数は、あるコンピューターで実行するためにキューに登録されたジョブの範囲を削除します。この関数を使用するには、ジョブ削除要求の送信先コンピューターでスケジュールサービスが開始されている必要があります。

戻り値

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

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

解説(Remarks)

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

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

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

1 つ以上のスケジュール済みジョブのジョブ識別子を取得するには、 NetScheduleJobEnum 関数を呼び出します。

NetScheduleJobDel 関数は、ジョブ識別子が MinJobId から MaxJobId までの範囲にあるすべてのジョブを削除します。

サーバー上のすべてのスケジュール済みジョブを削除するには、MinJobId に 0、MaxJobId に -1 を指定して NetScheduleJobDel を呼び出します。1 つのジョブを削除するには、MinJobId パラメーターと MaxJobId パラメーターの両方にそのジョブの識別子を指定します。

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

各言語での呼び出し定義

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

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

NetScheduleJobDel = ctypes.windll.netapi32.NetScheduleJobDel
NetScheduleJobDel.restype = wintypes.DWORD
NetScheduleJobDel.argtypes = [
    wintypes.LPCWSTR,  # Servername : LPCWSTR
    wintypes.DWORD,  # MinJobId : DWORD
    wintypes.DWORD,  # MaxJobId : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetScheduleJobDel = Fiddle::Function.new(
  lib['NetScheduleJobDel'],
  [
    Fiddle::TYPE_VOIDP,  # Servername : LPCWSTR
    -Fiddle::TYPE_INT,  # MinJobId : DWORD
    -Fiddle::TYPE_INT,  # MaxJobId : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetScheduleJobDel(
        Servername: *const u16,  // LPCWSTR
        MinJobId: u32,  // DWORD
        MaxJobId: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetScheduleJobDel([MarshalAs(UnmanagedType.LPWStr)] string Servername, uint MinJobId, uint MaxJobId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetScheduleJobDel' -Namespace Win32 -PassThru
# $api::NetScheduleJobDel(Servername, MinJobId, MaxJobId)
#uselib "NETAPI32.dll"
#func global NetScheduleJobDel "NetScheduleJobDel" sptr, sptr, sptr
; NetScheduleJobDel Servername, MinJobId, MaxJobId   ; 戻り値は stat
; Servername : LPCWSTR -> "sptr"
; MinJobId : DWORD -> "sptr"
; MaxJobId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "NETAPI32.dll"
#cfunc global NetScheduleJobDel "NetScheduleJobDel" wstr, int, int
; res = NetScheduleJobDel(Servername, MinJobId, MaxJobId)
; Servername : LPCWSTR -> "wstr"
; MinJobId : DWORD -> "int"
; MaxJobId : DWORD -> "int"
; DWORD NetScheduleJobDel(LPCWSTR Servername, DWORD MinJobId, DWORD MaxJobId)
#uselib "NETAPI32.dll"
#cfunc global NetScheduleJobDel "NetScheduleJobDel" wstr, int, int
; res = NetScheduleJobDel(Servername, MinJobId, MaxJobId)
; Servername : LPCWSTR -> "wstr"
; MinJobId : DWORD -> "int"
; MaxJobId : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetScheduleJobDel = netapi32.NewProc("NetScheduleJobDel")
)

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

extern "netapi32" fn NetScheduleJobDel(
    Servername: [*c]const u16, // LPCWSTR
    MinJobId: u32, // DWORD
    MaxJobId: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc NetScheduleJobDel(
    Servername: WideCString,  # LPCWSTR
    MinJobId: uint32,  # DWORD
    MaxJobId: uint32  # DWORD
): uint32 {.importc: "NetScheduleJobDel", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetScheduleJobDel(
    const(wchar)* Servername,   // LPCWSTR
    uint MinJobId,   // DWORD
    uint MaxJobId   // DWORD
);
ccall((:NetScheduleJobDel, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, UInt32),
      Servername, MinJobId, MaxJobId)
# Servername : LPCWSTR -> Cwstring
# MinJobId : DWORD -> UInt32
# MaxJobId : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetScheduleJobDel(
    const uint16_t* Servername,
    uint32_t MinJobId,
    uint32_t MaxJobId);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetScheduleJobDel(Servername, MinJobId, MaxJobId)
-- Servername : LPCWSTR
-- MinJobId : DWORD
-- MaxJobId : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetScheduleJobDel = lib.func('__stdcall', 'NetScheduleJobDel', 'uint32_t', ['str16', 'uint32_t', 'uint32_t']);
// NetScheduleJobDel(Servername, MinJobId, MaxJobId)
// Servername : LPCWSTR -> 'str16'
// MinJobId : DWORD -> 'uint32_t'
// MaxJobId : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetScheduleJobDel: { parameters: ["buffer", "u32", "u32"], result: "u32" },
});
// lib.symbols.NetScheduleJobDel(Servername, MinJobId, MaxJobId)
// Servername : LPCWSTR -> "buffer"
// MinJobId : DWORD -> "u32"
// MaxJobId : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetScheduleJobDel(
    const uint16_t* Servername,
    uint32_t MinJobId,
    uint32_t MaxJobId);
C, "NETAPI32.dll");
// $ffi->NetScheduleJobDel(Servername, MinJobId, MaxJobId);
// Servername : LPCWSTR
// MinJobId : DWORD
// MaxJobId : DWORD
// 構造体/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 NetScheduleJobDel(
        WString Servername,   // LPCWSTR
        int MinJobId,   // DWORD
        int MaxJobId   // DWORD
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetScheduleJobDel = NetScheduleJobDel(
    Servername : UInt16*,   # LPCWSTR
    MinJobId : UInt32,   # DWORD
    MaxJobId : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetScheduleJobDelNative = Uint32 Function(Pointer<Utf16>, Uint32, Uint32);
typedef NetScheduleJobDelDart = int Function(Pointer<Utf16>, int, int);
final NetScheduleJobDel = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetScheduleJobDelNative, NetScheduleJobDelDart>('NetScheduleJobDel');
// Servername : LPCWSTR -> Pointer<Utf16>
// MinJobId : DWORD -> Uint32
// MaxJobId : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetScheduleJobDel(
  Servername: PWideChar;   // LPCWSTR
  MinJobId: DWORD;   // DWORD
  MaxJobId: DWORD   // DWORD
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetScheduleJobDel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetScheduleJobDel"
  c_NetScheduleJobDel :: CWString -> Word32 -> Word32 -> IO Word32
-- Servername : LPCWSTR -> CWString
-- MinJobId : DWORD -> Word32
-- MaxJobId : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netschedulejobdel =
  foreign "NetScheduleJobDel"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* Servername : LPCWSTR -> (ptr uint16_t) *)
(* MinJobId : DWORD -> uint32_t *)
(* MaxJobId : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

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

関連項目

公式の関連項目