ホーム › Networking.HttpServer › HttpCreateServerSession

HttpCreateServerSession

関数

HTTPサーバーセッションを作成する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpCreateServerSession(
    HTTPAPI_VERSION Version,
    ULONGLONG* ServerSessionId,
    DWORD Reserved   // optional
);

パラメーター

名前	型	方向	説明
Version	HTTPAPI_VERSION	in	サーバーセッションのバージョンを示す HTTPAPI_VERSION 構造体です。バージョン 2.0 の場合は、構造体のインスタンスを宣言し、あらかじめ定義された値 HTTPAPI_VERSION_2 を設定してから HttpCreateServerSession に渡します。バージョンは 2.0 でなければなりません。HttpCreateServerSession はバージョン 1.0 の要求キューをサポートしません。
ServerSessionId	ULONGLONG*	out	サーバーセッションの ID を受け取る変数へのポインターです。
Reserved	DWORD	inoptional	予約済みです。0 でなければなりません。

名前

型

方向

説明

Version

HTTPAPI_VERSION

サーバーセッションのバージョンを示す HTTPAPI_VERSION 構造体です。バージョン 2.0 の場合は、構造体のインスタンスを宣言し、あらかじめ定義された値 HTTPAPI_VERSION_2 を設定してから HttpCreateServerSession に渡します。

バージョンは 2.0 でなければなりません。HttpCreateServerSession はバージョン 1.0 の要求キューをサポートしません。

ServerSessionId

ULONGLONG*

out

サーバーセッションの ID を受け取る変数へのポインターです。

Reserved

DWORD

inoptional

予約済みです。0 でなければなりません。

戻り値の型: DWORD

公式ドキュメント

指定したバージョンのサーバーセッションを作成します。

戻り値

関数が成功した場合は NO_ERROR を返します。

関数が失敗した場合は、次のいずれかのエラーコードを返します。

値	意味
ERROR_REVISION_MISMATCH	渡されたバージョンが無効か、サポートされていません。
ERROR_INVALID_PARAMETER	pServerSessionId パラメーターが null であるか、Reserved が 0 以外です。

解説(Remarks)

サーバーセッションは一連の URL グループを所有します。サーバーセッションは、その下に作成されるすべての URL グループに適用される構成情報を格納する、最上位の構成コンテナーです。サーバーセッションの構成について詳しくは、HttpSetServerSessionProperty を参照してください。

HTTP Server API は、サーバーセッションに対する非同期 I/O をサポートしません。

サーバーセッションが不要になったとき、またはアプリケーションを終了する前に、アプリケーションは HttpCloseServerSession を呼び出してサーバーセッションを削除しなければなりません。サーバーセッションが削除されると、関連付けられたすべての URL グループも自動的に削除されます。

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

各言語での呼び出し定義

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

DWORD HttpCreateServerSession(
    HTTPAPI_VERSION Version,
    ULONGLONG* ServerSessionId,
    DWORD Reserved   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpCreateServerSession(
    HTTPAPI_VERSION Version,   // HTTPAPI_VERSION
    out ulong ServerSessionId,   // ULONGLONG* out
    uint Reserved   // DWORD optional
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpCreateServerSession(
    Version As HTTPAPI_VERSION,   ' HTTPAPI_VERSION
    <Out> ByRef ServerSessionId As ULong,   ' ULONGLONG* out
    Reserved As UInteger   ' DWORD optional
) As UInteger
End Function

' Version : HTTPAPI_VERSION
' ServerSessionId : ULONGLONG* out
' Reserved : DWORD optional
Declare PtrSafe Function HttpCreateServerSession Lib "httpapi" ( _
    ByVal Version As LongPtr, _
    ByRef ServerSessionId As LongLong, _
    ByVal Reserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpCreateServerSession = ctypes.windll.httpapi.HttpCreateServerSession
HttpCreateServerSession.restype = wintypes.DWORD
HttpCreateServerSession.argtypes = [
    HTTPAPI_VERSION,  # Version : HTTPAPI_VERSION
    ctypes.POINTER(ctypes.c_ulonglong),  # ServerSessionId : ULONGLONG* out
    wintypes.DWORD,  # Reserved : DWORD optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpCreateServerSession = Fiddle::Function.new(
  lib['HttpCreateServerSession'],
  [
    Fiddle::TYPE_VOIDP,  # Version : HTTPAPI_VERSION
    Fiddle::TYPE_VOIDP,  # ServerSessionId : ULONGLONG* out
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpCreateServerSession(
        Version: HTTPAPI_VERSION,  // HTTPAPI_VERSION
        ServerSessionId: *mut u64,  // ULONGLONG* out
        Reserved: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpCreateServerSession(HTTPAPI_VERSION Version, out ulong ServerSessionId, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpCreateServerSession' -Namespace Win32 -PassThru
# $api::HttpCreateServerSession(Version, ServerSessionId, Reserved)

#uselib "HTTPAPI.dll"
#func global HttpCreateServerSession "HttpCreateServerSession" sptr, sptr, sptr
; HttpCreateServerSession Version, varptr(ServerSessionId), Reserved   ; 戻り値は stat
; Version : HTTPAPI_VERSION -> "sptr"
; ServerSessionId : ULONGLONG* out -> "sptr"
; Reserved : DWORD optional -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpCreateServerSession "HttpCreateServerSession" int, var, int
; res = HttpCreateServerSession(Version, ServerSessionId, Reserved)
; Version : HTTPAPI_VERSION -> "int"
; ServerSessionId : ULONGLONG* out -> "var"
; Reserved : DWORD optional -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "HTTPAPI.dll"
#cfunc global HttpCreateServerSession "HttpCreateServerSession" int, sptr, int
; res = HttpCreateServerSession(Version, varptr(ServerSessionId), Reserved)
; Version : HTTPAPI_VERSION -> "int"
; ServerSessionId : ULONGLONG* out -> "sptr"
; Reserved : DWORD optional -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。