opcobjectmodel.idl 4.99 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * Copyright 2018 Nikolay Sivov for CodeWeavers
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

#if 0
#pragma makedep install
#endif

23 24 25
interface IOpcPartUri;
interface IOpcUri;
interface IOpcRelationship;
26
interface IOpcRelationshipSet;
27

28 29 30 31 32 33 34 35 36 37 38 39
typedef [v1_enum] enum
{
    OPC_READ_DEFAULT = 0,
    OPC_VALIDATE_ON_LOAD = 1,
    OPC_CACHE_ON_ACCESS = 2,
} OPC_READ_FLAGS;

typedef [v1_enum] enum
{
    OPC_WRITE_DEFAULT = 0,
    OPC_WRITE_FORCE_ZIP32 = 1,
} OPC_WRITE_FLAGS;
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
[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee71),
    pointer_default(ref)
]
interface IOpcPart : IUnknown
{
    HRESULT GetRelationshipSet(
        [out, retval] IOpcRelationshipSet **relationship_set
    );

    HRESULT GetContentStream(
        [out, retval] IStream **stream
    );

    HRESULT GetName(
        [out, retval] IOpcPartUri **name
    );

    HRESULT GetContentType(
        [out, string, retval] LPWSTR *type
    );

    HRESULT GetCompressionOptions(
        [out, retval] OPC_COMPRESSION_OPTIONS *options
    );
}

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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee75),
    pointer_default(ref)
]
interface IOpcPartEnumerator : IUnknown
{
    HRESULT MoveNext(
        [out, retval] BOOL *has_next
    );

    HRESULT MovePrevious(
        [out, retval] BOOL *has_previous
    );

    HRESULT GetCurrent(
        [out, retval] IOpcPart **part
    );

    HRESULT Clone(
        [out, retval] IOpcPartEnumerator **enumerator
    );
}

[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee76),
    pointer_default(ref)
]
interface IOpcRelationshipEnumerator : IUnknown
{
    HRESULT MoveNext(
        [out, retval] BOOL *has_next
    );

    HRESULT MovePrevious(
        [out, retval] BOOL *has_previous
    );

    HRESULT GetCurrent(
        [out, retval] IOpcRelationship **relationship
    );

    HRESULT Clone(
        [out, retval] IOpcRelationshipEnumerator **enumerator
    );
}

[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee73),
    pointer_default(ref)
]
interface IOpcPartSet : IUnknown
{
    HRESULT GetPart(
        [in] IOpcPartUri *name,
        [out, retval] IOpcPart **part
    );

    HRESULT CreatePart(
        [in] IOpcPartUri *name,
        [in, string] LPCWSTR content_type,
        [in] OPC_COMPRESSION_OPTIONS compression_options,
        [out, retval] IOpcPart **part
    );

    HRESULT DeletePart(
        [in] IOpcPartUri *name
    );

    HRESULT PartExists(
        [in] IOpcPartUri *name,
        [out, retval] BOOL *exists
    );

    HRESULT GetEnumerator(
        [out, retval] IOpcPartEnumerator **enumerator
    );
}

[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee72),
    pointer_default(ref)
]
interface IOpcRelationship : IUnknown
{
    HRESULT GetId(
        [out, string, retval] LPWSTR *id
    );

    HRESULT GetRelationshipType(
        [out, string, retval] LPWSTR *type
    );

    HRESULT GetSourceUri(
        [out, retval] IOpcUri **uri
    );

    HRESULT GetTargetUri(
        [out, retval] IUri **target
    );

    HRESULT GetTargetMode(
        [out, retval] OPC_URI_TARGET_MODE *target_mode
    );
}


[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee74),
    pointer_default(ref)
]
interface IOpcRelationshipSet : IUnknown
{
    HRESULT GetRelationship(
        [in, string] LPCWSTR id,
        [out, retval] IOpcRelationship **relationship
    );

    HRESULT CreateRelationship(
        [in, string, unique] LPCWSTR id,
        [in, string] LPCWSTR type,
        [in] IUri *target_uri,
        [in] OPC_URI_TARGET_MODE target_mode,
        [out, retval] IOpcRelationship **relationship
    );

    HRESULT DeleteRelationship(
        [in, string] LPCWSTR id
    );

    HRESULT RelationshipExists(
        [in, string] LPCWSTR id,
        [out, retval] BOOL *exists
    );

    HRESULT GetEnumerator(
        [out, retval] IOpcRelationshipEnumerator **enumerator
    );

    HRESULT GetEnumeratorForType(
        [in, string] LPCWSTR type,
        [out, retval] IOpcRelationshipEnumerator **enumerator
    );

    HRESULT GetRelationshipsContentStream(
        [out, retval] IStream **stream
    );
}

[
    object,
    uuid(42195949-3b79-4fc8-89c6-fc7fb979ee70),
    pointer_default(ref)
]
interface IOpcPackage : IUnknown
{
    HRESULT GetPartSet(
        [out, retval] IOpcPartSet **part_set
    );

    HRESULT GetRelationshipSet(
        [out, retval] IOpcRelationshipSet **relationship_set
    );
}