{"id":107450,"date":"2022-11-25T07:00:00","date_gmt":"2022-11-25T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=107450"},"modified":"2022-11-24T06:24:31","modified_gmt":"2022-11-24T14:24:31","slug":"20221125-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20221125-00\/?p=107450","title":{"rendered":"How do I pass a raw pointer to a Windows Runtime function?"},"content":{"rendered":"

A customer was trying to create a Windows Runtime function that accepts a raw pointer, but they got an error:<\/p>\n

namespace MyNamespace\r\n{\r\n    runtimeclass MyClass\r\n    {\r\n        void Transform(Int32 count, Int16* input, Int16* output);\r\n    }\r\n}\r\n<\/pre>\n
The compilation files with the error<\/p>\n
MIDL2025 [msg]syntax error [context]: expecting an identifier near \"*\"\r\n<\/pre>\n
What’s going on?<\/p>\n
The Windows Runtime does not support raw pointers at the projection level. Many programming languages don’t have pointers at all (such as JavaScript and Python), and others restrict their use (C#, Rust). The Windows Runtime tries to be friendly to a large number of languages, and pointers are somewhat out of fashion in modern programming languages because they are so easy to use incorrectly.<\/p>\n
In this particular customer’s case, they wanted to pass a buffer into the method without copying, and to receive the results directly into a caller-provided buffer. Fortunately, these are already expressible with  the existing array-passing patterns<\/a>.<\/p>\n
void Transform(Int32[] input, ref Int32[] output);\r\n<\/pre>\n
The input buffer is a read-only array, and the output buffer is a write-only array.<\/p>\n
For output pointers to single elements, you can use the out<\/code> keyword.<\/p>\n
bool TryGetCount(out Int32 count);\r\n<\/pre>\n
Bonus reading<\/b>:  How does JavaScript represent output parameters in the Windows Runtime<\/a>?<\/p>\n
Bonus chatter<\/b>: You may have noticed that I didn’t mention input pointers to single elements. That’s because you can just pass those by value.<\/p>\n","protected":false},"excerpt":{"rendered":"
Raw pointers don’t exist in the Windows Runtime, so you’ll have to re-express it in terms of something that does.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-107450","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Raw pointers don’t exist in the Windows Runtime, so you’ll have to re-express it in terms of something that does.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/107450","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=107450"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/107450\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=107450"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=107450"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=107450"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}