Win32 API 日本語リファレンス
ホーム › Security.Cryptography.Certificates › CertSrvServerControlW

CertSrvServerControlW

関数
証明書サービスサーバーに対して制御コマンドを送信する。
DLLcertadm.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

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

HRESULT CertSrvServerControlW(
    LPCWSTR pwszServerName,
    DWORD dwControlFlags,
    DWORD* pcbOut,
    BYTE** ppbOut
);

パラメーター

名前型方向説明
pwszServerNameLPCWSTRin制御コマンドの発行先となるサーバーの名前または構成文字列へのポインター。
dwControlFlagsDWORDin

pwszServerName で指定した Certificate Services サーバーに対して発行する制御コマンドを表す値。dwControlFlags では次の値がサポートされます。

値 意味
CSCONTROL_SHUTDOWN
Certificate Services を停止します。
pcbOutDWORD*inout将来の使用のためのパラメーターで、ppbOut に割り当てられたバイト数になります。現在の実装では ppbOut にメモリを割り当てません。この値には NULL を設定できます。
ppbOutBYTE**inout将来の使用のためのパラメーターで、発行したコマンドの出力を表すバイト列へのポインターのポインターになります。現在の実装では ppbOut にメモリを割り当てません。この値には NULL を設定できます。

戻り値の型: HRESULT

公式ドキュメント

サービス制御コマンドを発行して、プログラムから Certificate Services を停止します。

戻り値

戻り値は HRESULT です。S_OK は成功を示します。

解説(Remarks)

この関数の目的は、バックアップまたは復元を行うアプリケーションが、プログラムから Certificate Services アプリケーションを停止できるようにすることです (これにより、サービス コントローラー API を使用する必要がなくなります)。この方法で Certificate Services を停止する方式は、Certificate Services がコンソール モードで実行されている場合にも機能します。サービス コントローラー API では、コンソール モードで実行されているアプリケーションを制御できません。

Certadm.dll におけるこの関数の名前は CertSrvServerControlW です。GetProcAddress を呼び出すときは、この形式の名前を使用する必要があります。また、この関数は Certbcli.h ヘッダー ファイルで FNCERTSRVSERVERCONTROLW 型として定義されています。

例

FNCERTSRVSERVERCONTROLW* pfnControl;
char * szControlFunc = "CertSrvServerControlW";
HRESULT    hr=0;

// 目的の関数のアドレスを取得します。
// hInst は Certadm.dll に対して LoadLibrary を呼び出して設定済みです。
pfnControl = (FNCERTSRVSERVERCONTROLW*)GetProcAddress(hInst,
                                           szControlFunc);
if ( NULL == pfnControl )
{
    printf("Failed GetProcAddress - %s, error=%d
",
           szControlFunc,
           GetLastError() );
    exit(1); // または他の適切なエラー処理。
}

// サービスを停止するコマンドを発行します。
hr = pfnControl( L"MyCertServMachine",
                 CSCONTROL_SHUTDOWN,
                 NULL,
                 NULL);

if ( FAILED( hr ) )
{
    printf("Failed pfnControl call [%x]
", hr);
    exit(1); // または他の適切なエラー処理。
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

CertSrvServerControlW = ctypes.windll.certadm.CertSrvServerControlW
CertSrvServerControlW.restype = ctypes.c_int
CertSrvServerControlW.argtypes = [
    wintypes.LPCWSTR,  # pwszServerName : LPCWSTR
    wintypes.DWORD,  # dwControlFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbOut : DWORD* in/out
    ctypes.c_void_p,  # ppbOut : BYTE** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	certadm = windows.NewLazySystemDLL("certadm.dll")
	procCertSrvServerControlW = certadm.NewProc("CertSrvServerControlW")
)

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

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

typedef CertSrvServerControlWNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Uint8>);
typedef CertSrvServerControlWDart = int Function(Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Uint8>);
final CertSrvServerControlW = DynamicLibrary.open('certadm.dll')
    .lookupFunction<CertSrvServerControlWNative, CertSrvServerControlWDart>('CertSrvServerControlW');
// pwszServerName : LPCWSTR -> Pointer<Utf16>
// dwControlFlags : DWORD -> Uint32
// pcbOut : DWORD* in/out -> Pointer<Uint32>
// ppbOut : BYTE** in/out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CertSrvServerControlW(
  pwszServerName: PWideChar;   // LPCWSTR
  dwControlFlags: DWORD;   // DWORD
  pcbOut: Pointer;   // DWORD* in/out
  ppbOut: Pointer   // BYTE** in/out
): Integer; stdcall;
  external 'certadm.dll' name 'CertSrvServerControlW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let certsrvservercontrolw =
  foreign "CertSrvServerControlW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint8_t) @-> returning int32_t)
(* pwszServerName : LPCWSTR -> (ptr uint16_t) *)
(* dwControlFlags : DWORD -> uint32_t *)
(* pcbOut : DWORD* in/out -> (ptr uint32_t) *)
(* ppbOut : BYTE** in/out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library certadm (t "certadm.dll"))
(cffi:use-foreign-library certadm)

(cffi:defcfun ("CertSrvServerControlW" cert-srv-server-control-w :convention :stdcall) :int32
  (pwsz-server-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-control-flags :uint32)   ; DWORD
  (pcb-out :pointer)   ; DWORD* in/out
  (ppb-out :pointer))   ; BYTE** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CertSrvServerControlW = Win32::API::More->new('certadm',
    'int CertSrvServerControlW(LPCWSTR pwszServerName, DWORD dwControlFlags, LPVOID pcbOut, LPVOID ppbOut)');
# my $ret = $CertSrvServerControlW->Call($pwszServerName, $dwControlFlags, $pcbOut, $ppbOut);
# pwszServerName : LPCWSTR -> LPCWSTR
# dwControlFlags : DWORD -> DWORD
# pcbOut : DWORD* in/out -> LPVOID
# ppbOut : BYTE** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。