Win32 API 日本語リファレンス
ホームNetworking.WinInet › InternetGoOnlineA

InternetGoOnlineA

関数
指定URLへのオンライン接続をユーザーに促す(ANSI版)。
DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetGoOnlineA(
    LPCSTR lpszURL,   // optional
    HWND hwndParent,
    DWORD dwFlags
);

パラメーター

名前方向説明
lpszURLLPCSTRinoptional接続先となる Web サイトの URL を指定する、null で終わる文字列へのポインターです。
hwndParentHWNDin親ウィンドウのハンドルです。
dwFlagsDWORDin

このパラメーターには、0 または次のフラグを指定できます。

Value Meaning
INTERNET_GOONLINE_REFRESH
このフラグは使用されません。

戻り値の型: BOOL

公式ドキュメント

InternetGoOnlineA (ANSI) 関数 (wininet.h) は、URL への接続を開始する許可をユーザーに求めます。

戻り値

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

関数が失敗した場合は FALSE を返します。アプリケーションは GetLastError を呼び出してエラーコードを取得できます。

関数が失敗した場合、次のエラーコードを返すことがあります。

Return code Description
ERROR_INVALID_PARAMETER
1 つ以上のパラメーターが正しくありません。

dwFlags パラメーターに、0 または INTERNET_GOONLINE_REFRESH 以外の値が含まれています。

解説(Remarks)

Note WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

wininet.h ヘッダーは InternetGoOnline を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetGoOnlineA(
    LPCSTR lpszURL,   // optional
    HWND hwndParent,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetGoOnlineA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszURL,   // LPCSTR optional
    IntPtr hwndParent,   // HWND
    uint dwFlags   // DWORD
);
<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetGoOnlineA(
    <MarshalAs(UnmanagedType.LPStr)> lpszURL As String,   ' LPCSTR optional
    hwndParent As IntPtr,   ' HWND
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszURL : LPCSTR optional
' hwndParent : HWND
' dwFlags : DWORD
Declare PtrSafe Function InternetGoOnlineA Lib "wininet" ( _
    ByVal lpszURL As String, _
    ByVal hwndParent As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternetGoOnlineA = ctypes.windll.wininet.InternetGoOnlineA
InternetGoOnlineA.restype = wintypes.BOOL
InternetGoOnlineA.argtypes = [
    wintypes.LPCSTR,  # lpszURL : LPCSTR optional
    wintypes.HANDLE,  # hwndParent : HWND
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetGoOnlineA = Fiddle::Function.new(
  lib['InternetGoOnlineA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszURL : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # hwndParent : HWND
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn InternetGoOnlineA(
        lpszURL: *const u8,  // LPCSTR optional
        hwndParent: *mut core::ffi::c_void,  // HWND
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool InternetGoOnlineA([MarshalAs(UnmanagedType.LPStr)] string lpszURL, IntPtr hwndParent, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGoOnlineA' -Namespace Win32 -PassThru
# $api::InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
#uselib "WININET.dll"
#func global InternetGoOnlineA "InternetGoOnlineA" sptr, sptr, sptr
; InternetGoOnlineA lpszURL, hwndParent, dwFlags   ; 戻り値は stat
; lpszURL : LPCSTR optional -> "sptr"
; hwndParent : HWND -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetGoOnlineA "InternetGoOnlineA" str, sptr, int
; res = InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
; lpszURL : LPCSTR optional -> "str"
; hwndParent : HWND -> "sptr"
; dwFlags : DWORD -> "int"
; BOOL InternetGoOnlineA(LPCSTR lpszURL, HWND hwndParent, DWORD dwFlags)
#uselib "WININET.dll"
#cfunc global InternetGoOnlineA "InternetGoOnlineA" str, intptr, int
; res = InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
; lpszURL : LPCSTR optional -> "str"
; hwndParent : HWND -> "intptr"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetGoOnlineA = wininet.NewProc("InternetGoOnlineA")
)

// lpszURL (LPCSTR optional), hwndParent (HWND), dwFlags (DWORD)
r1, _, err := procInternetGoOnlineA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszURL))),
	uintptr(hwndParent),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InternetGoOnlineA(
  lpszURL: PAnsiChar;   // LPCSTR optional
  hwndParent: THandle;   // HWND
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetGoOnlineA';
result := DllCall("WININET\InternetGoOnlineA"
    , "AStr", lpszURL   ; LPCSTR optional
    , "Ptr", hwndParent   ; HWND
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL
●InternetGoOnlineA(lpszURL, hwndParent, dwFlags) = DLL("WININET.dll", "bool InternetGoOnlineA(char*, void*, dword)")
# 呼び出し: InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
# lpszURL : LPCSTR optional -> "char*"
# hwndParent : HWND -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn InternetGoOnlineA(
    lpszURL: [*c]const u8, // LPCSTR optional
    hwndParent: ?*anyopaque, // HWND
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc InternetGoOnlineA(
    lpszURL: cstring,  # LPCSTR optional
    hwndParent: pointer,  # HWND
    dwFlags: uint32  # DWORD
): int32 {.importc: "InternetGoOnlineA", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int InternetGoOnlineA(
    const(char)* lpszURL,   // LPCSTR optional
    void* hwndParent,   // HWND
    uint dwFlags   // DWORD
);
ccall((:InternetGoOnlineA, "WININET.dll"), stdcall, Int32,
      (Cstring, Ptr{Cvoid}, UInt32),
      lpszURL, hwndParent, dwFlags)
# lpszURL : LPCSTR optional -> Cstring
# hwndParent : HWND -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InternetGoOnlineA(
    const char* lpszURL,
    void* hwndParent,
    uint32_t dwFlags);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
-- lpszURL : LPCSTR optional
-- hwndParent : HWND
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetGoOnlineA = lib.func('__stdcall', 'InternetGoOnlineA', 'int32_t', ['str', 'void *', 'uint32_t']);
// InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
// lpszURL : LPCSTR optional -> 'str'
// hwndParent : HWND -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  InternetGoOnlineA: { parameters: ["buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.InternetGoOnlineA(lpszURL, hwndParent, dwFlags)
// lpszURL : LPCSTR optional -> "buffer"
// hwndParent : HWND -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InternetGoOnlineA(
    const char* lpszURL,
    void* hwndParent,
    uint32_t dwFlags);
C, "WININET.dll");
// $ffi->InternetGoOnlineA(lpszURL, hwndParent, dwFlags);
// lpszURL : LPCSTR optional
// hwndParent : HWND
// dwFlags : 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 Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.ASCII_OPTIONS);
    boolean InternetGoOnlineA(
        String lpszURL,   // LPCSTR optional
        Pointer hwndParent,   // HWND
        int dwFlags   // DWORD
    );
}
@[Link("wininet")]
lib LibWININET
  fun InternetGoOnlineA = InternetGoOnlineA(
    lpszURL : UInt8*,   # LPCSTR optional
    hwndParent : Void*,   # HWND
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetGoOnlineANative = Int32 Function(Pointer<Utf8>, Pointer<Void>, Uint32);
typedef InternetGoOnlineADart = int Function(Pointer<Utf8>, Pointer<Void>, int);
final InternetGoOnlineA = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetGoOnlineANative, InternetGoOnlineADart>('InternetGoOnlineA');
// lpszURL : LPCSTR optional -> Pointer<Utf8>
// hwndParent : HWND -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetGoOnlineA(
  lpszURL: PAnsiChar;   // LPCSTR optional
  hwndParent: THandle;   // HWND
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetGoOnlineA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetGoOnlineA"
  c_InternetGoOnlineA :: CString -> Ptr () -> Word32 -> IO CInt
-- lpszURL : LPCSTR optional -> CString
-- hwndParent : HWND -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetgoonlinea =
  foreign "InternetGoOnlineA"
    (string @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* lpszURL : LPCSTR optional -> string *)
(* hwndParent : HWND -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetGoOnlineA" internet-go-online-a :convention :stdcall) :int32
  (lpsz-url :string)   ; LPCSTR optional
  (hwnd-parent :pointer)   ; HWND
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetGoOnlineA = Win32::API::More->new('WININET',
    'BOOL InternetGoOnlineA(LPCSTR lpszURL, HANDLE hwndParent, DWORD dwFlags)');
# my $ret = $InternetGoOnlineA->Call($lpszURL, $hwndParent, $dwFlags);
# lpszURL : LPCSTR optional -> LPCSTR
# hwndParent : HWND -> HANDLE
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い