aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/go-ole/go-ole/connect.go
blob: b2ac2ec67ac9fb5c6e23eefbc8d3edaf1319e0e6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
package ole

// Connection contains IUnknown for fluent interface interaction.
//
// Deprecated. Use oleutil package instead.
type Connection struct {
    Object *IUnknown // Access COM
}

// Initialize COM.
func (*Connection) Initialize() (err error) {
    return coInitialize()
}

// Uninitialize COM.
func (*Connection) Uninitialize() {
    CoUninitialize()
}

// Create IUnknown object based first on ProgId and then from String.
func (c *Connection) Create(progId string) (err error) {
    var clsid *GUID
    clsid, err = CLSIDFromProgID(progId)
    if err != nil {
        clsid, err = CLSIDFromString(progId)
        if err != nil {
            return
        }
    }

    unknown, err := CreateInstance(clsid, IID_IUnknown)
    if err != nil {
        return
    }
    c.Object = unknown

    return
}

// Release IUnknown object.
func (c *Connection) Release() {
    c.Object.Release()
}

// Load COM object from list of programIDs or strings.
func (c *Connection) Load(names ...string) (errors []error) {
    var tempErrors []error = make([]error, len(names))
    var numErrors int = 0
    for _, name := range names {
        err := c.Create(name)
        if err != nil {
            tempErrors = append(tempErrors, err)
            numErrors += 1
            continue
        }
        break
    }

    copy(errors, tempErrors[0:numErrors])
    return
}

// Dispatch returns Dispatch object.
func (c *Connection) Dispatch() (object *Dispatch, err error) {
    dispatch, err := c.Object.QueryInterface(IID_IDispatch)
    if err != nil {
        return
    }
    object = &Dispatch{dispatch}
    return
}

// Dispatch stores IDispatch object.
type Dispatch struct {
    Object *IDispatch // Dispatch object.
}

// Call method on IDispatch with parameters.
func (d *Dispatch) Call(method string, params ...interface{}) (result *VARIANT, err error) {
    id, err := d.GetId(method)
    if err != nil {
        return
    }

    result, err = d.Invoke(id, DISPATCH_METHOD, params)
    return
}

// MustCall method on IDispatch with parameters.
func (d *Dispatch) MustCall(method string, params ...interface{}) (result *VARIANT) {
    id, err := d.GetId(method)
    if err != nil {
        panic(err)
    }

    result, err = d.Invoke(id, DISPATCH_METHOD, params)
    if err != nil {
        panic(err)
    }

    return
}

// Get property on IDispatch with parameters.
func (d *Dispatch) Get(name string, params ...interface{}) (result *VARIANT, err error) {
    id, err := d.GetId(name)
    if err != nil {
        return
    }
    result, err = d.Invoke(id, DISPATCH_PROPERTYGET, params)
    return
}

// MustGet property on IDispatch with parameters.
func (d *Dispatch) MustGet(name string, params ...interface{}) (result *VARIANT) {
    id, err := d.GetId(name)
    if err != nil {
        panic(err)
    }

    result, err = d.Invoke(id, DISPATCH_PROPERTYGET, params)
    if err != nil {
        panic(err)
    }
    return
}

// Set property on IDispatch with parameters.
func (d *Dispatch) Set(name string, params ...interface{}) (result *VARIANT, err error) {
    id, err := d.GetId(name)
    if err != nil {
        return
    }
    result, err = d.Invoke(id, DISPATCH_PROPERTYPUT, params)
    return
}

// MustSet property on IDispatch with parameters.
func (d *Dispatch) MustSet(name string, params ...interface{}) (result *VARIANT) {
    id, err := d.GetId(name)
    if err != nil {
        panic(err)
    }

    result, err = d.Invoke(id, DISPATCH_PROPERTYPUT, params)
    if err != nil {
        panic(err)
    }
    return
}

// GetId retrieves ID of name on IDispatch.
func (d *Dispatch) GetId(name string) (id int32, err error) {
    var dispid []int32
    dispid, err = d.Object.GetIDsOfName([]string{name})
    if err != nil {
        return
    }
    id = dispid[0]
    return
}

// GetIds retrieves all IDs of names on IDispatch.
func (d *Dispatch) GetIds(names ...string) (dispid []int32, err error) {
    dispid, err = d.Object.GetIDsOfName(names)
    return
}

// Invoke IDispatch on DisplayID of dispatch type with parameters.
//
// There have been problems where if send cascading params..., it would error
// out because the parameters would be empty.
func (d *Dispatch) Invoke(id int32, dispatch int16, params []interface{}) (result *VARIANT, err error) {
    if len(params) < 1 {
        result, err = d.Object.Invoke(id, dispatch)
    } else {
        result, err = d.Object.Invoke(id, dispatch, params...)
    }
    return
}

// Release IDispatch object.
func (d *Dispatch) Release() {
    d.Object.Release()
}

// Connect initializes COM and attempts to load IUnknown based on given names.
func Connect(names ...string) (connection *Connection) {
    connection.Initialize()
    connection.Load(names...)
    return
}