ホーム › Security.Cryptography.Certificates › CertSrvIsServerOnlineW

CertSrvIsServerOnlineW

関数

証明書サービスサーバーがオンライン状態かどうかを確認する。

DLLcertadm.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

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

HRESULT CertSrvIsServerOnlineW(
    LPCWSTR pwszServerName,
    BOOL* pfServerOnline
);

パラメーター

名前	型	方向	説明
pwszServerName	LPCWSTR	in	オンライン状態を確認するサーバーの NetBIOS 名または DNS マシン名へのポインター。
pfServerOnline	BOOL*	inout	ブール値へのポインター。Certificate Services サーバーがオンラインの場合は TRUE、オンラインでない場合は FALSE が格納されます。

戻り値の型: HRESULT

公式ドキュメント

Certificate Services サーバーがオンラインかどうかを判定します。Certificate Services サーバーがオンラインでない場合、バックアップ操作は成功しません。

戻り値

戻り値は HRESULT です。Certificate Services が実行されていない場合、この関数は失敗します。Certificate Services が実行中で要求を受け付けられる状態の場合、この関数は S_OK を返し、pfServerOnline は TRUE の値を指します。Certificate Services が中断 (一時停止) モードで実行されている場合、この関数は S_OK を返し、pfServerOnline は FALSE の値を指します。

解説(Remarks)

Certificate Services サーバーがオンラインであり、バックアップ操作に使用できるかどうかを判定するには、この関数を呼び出します。

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

例

FNCERTSRVISSERVERONLINEW* pfnOnline = NULL;
char * szOnlineFunc = "CertSrvIsServerOnlineW";
BOOL       bOnline = 0;
HRESULT    hr = 0;

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

// 関数を呼び出します。wszServer には事前にサーバー名を設定してあります。
hr = pfnOnline(wszServer, &bOnline);
if (FAILED(hr))
{
    printf("Failed pfnOnline, hr=%x, err=%d
",
           hr,
           GetLastError());
    exit(1);  // または、その他の適切なエラー処理。
}

// オンライン状態を表示します。
printf("Server is %s
", 
       (bOnline ? "Online" : "Suspended" ));

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

各言語での呼び出し定義

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

HRESULT CertSrvIsServerOnlineW(
    LPCWSTR pwszServerName,
    BOOL* pfServerOnline
);

[DllImport("certadm.dll", ExactSpelling = true)]
static extern int CertSrvIsServerOnlineW(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszServerName,   // LPCWSTR
    ref bool pfServerOnline   // BOOL* in/out
);

<DllImport("certadm.dll", ExactSpelling:=True)>
Public Shared Function CertSrvIsServerOnlineW(
    <MarshalAs(UnmanagedType.LPWStr)> pwszServerName As String,   ' LPCWSTR
    ByRef pfServerOnline As Boolean   ' BOOL* in/out
) As Integer
End Function

' pwszServerName : LPCWSTR
' pfServerOnline : BOOL* in/out
Declare PtrSafe Function CertSrvIsServerOnlineW Lib "certadm" ( _
    ByVal pwszServerName As LongPtr, _
    ByRef pfServerOnline As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertSrvIsServerOnlineW = ctypes.windll.certadm.CertSrvIsServerOnlineW
CertSrvIsServerOnlineW.restype = ctypes.c_int
CertSrvIsServerOnlineW.argtypes = [
    wintypes.LPCWSTR,  # pwszServerName : LPCWSTR
    ctypes.c_void_p,  # pfServerOnline : BOOL* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('certadm.dll')
CertSrvIsServerOnlineW = Fiddle::Function.new(
  lib['CertSrvIsServerOnlineW'],
  [
    Fiddle::TYPE_VOIDP,  # pwszServerName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pfServerOnline : BOOL* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "certadm")]
extern "system" {
    fn CertSrvIsServerOnlineW(
        pwszServerName: *const u16,  // LPCWSTR
        pfServerOnline: *mut i32  // BOOL* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("certadm.dll")]
public static extern int CertSrvIsServerOnlineW([MarshalAs(UnmanagedType.LPWStr)] string pwszServerName, ref bool pfServerOnline);
"@
$api = Add-Type -MemberDefinition $sig -Name 'certadm_CertSrvIsServerOnlineW' -Namespace Win32 -PassThru
# $api::CertSrvIsServerOnlineW(pwszServerName, pfServerOnline)

#uselib "certadm.dll"
#func global CertSrvIsServerOnlineW "CertSrvIsServerOnlineW" sptr, sptr
; CertSrvIsServerOnlineW pwszServerName, varptr(pfServerOnline)   ; 戻り値は stat
; pwszServerName : LPCWSTR -> "sptr"
; pfServerOnline : BOOL* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "certadm.dll"
#cfunc global CertSrvIsServerOnlineW "CertSrvIsServerOnlineW" wstr, var
; res = CertSrvIsServerOnlineW(pwszServerName, pfServerOnline)
; pwszServerName : LPCWSTR -> "wstr"
; pfServerOnline : BOOL* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "certadm.dll"
#cfunc global CertSrvIsServerOnlineW "CertSrvIsServerOnlineW" wstr, sptr
; res = CertSrvIsServerOnlineW(pwszServerName, varptr(pfServerOnline))
; pwszServerName : LPCWSTR -> "wstr"
; pfServerOnline : BOOL* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。