Mercurial > dwindows
comparison template/dw.c @ 1008:f046a2712b38
Fixes to errors in documentation comments while importing them into the help database.
author | bsmith@81767d24-ef19-dc11-ae90-00e081727c95 |
---|---|
date | Sat, 14 May 2011 05:17:27 +0000 |
parents | 870a95961b4a |
children | 9af693aafa93 |
comparison
equal
deleted
inserted
replaced
1007:870a95961b4a | 1008:f046a2712b38 |
---|---|
643 { | 643 { |
644 return 0; | 644 return 0; |
645 } | 645 } |
646 | 646 |
647 /* | 647 /* |
648 * Returns the position of the scrollbar in the scrollbox | 648 * Returns the position of the scrollbar in the scrollbox. |
649 * Parameters: | 649 * Parameters: |
650 * handle: Handle to the scrollbox to be queried. | 650 * handle: Handle to the scrollbox to be queried. |
651 * orient: The vertical or horizontal scrollbar. | 651 * orient: The vertical or horizontal scrollbar. |
652 * Returns: | 652 * Returns: |
653 * The vertical or horizontal position in the scrollbox. | 653 * The vertical or horizontal position in the scrollbox. |
654 */ | 654 */ |
655 int API dw_scrollbox_get_pos(HWND handle, int orient) | 655 int API dw_scrollbox_get_pos(HWND handle, int orient) |
656 { | 656 { |
657 return 0; | 657 return 0; |
658 } | 658 } |
659 | 659 |
1001 | 1001 |
1002 /* | 1002 /* |
1003 * Create a new scrollbar window (widget) to be packed. | 1003 * Create a new scrollbar window (widget) to be packed. |
1004 * Parameters: | 1004 * Parameters: |
1005 * vertical: TRUE or FALSE if scrollbar is vertical. | 1005 * vertical: TRUE or FALSE if scrollbar is vertical. |
1006 * increments: Number of increments available. | |
1007 * id: An ID to be used with dw_window_from_id() or 0L. | 1006 * id: An ID to be used with dw_window_from_id() or 0L. |
1008 * Returns: | 1007 * Returns: |
1009 * A handle to a scrollbar window or NULL on failure. | 1008 * A handle to a scrollbar window or NULL on failure. |
1010 */ | 1009 */ |
1011 HWND API dw_scrollbar_new(int vertical, ULONG cid) | 1010 HWND API dw_scrollbar_new(int vertical, ULONG cid) |
1514 * Parameters: | 1513 * Parameters: |
1515 * handle: Handle to the window. | 1514 * handle: Handle to the window. |
1516 * pixmap: Handle to the pixmap. (choose only one of these) | 1515 * pixmap: Handle to the pixmap. (choose only one of these) |
1517 * text: Text to be queried. | 1516 * text: Text to be queried. |
1518 * width: Pointer to a variable to be filled in with the width. | 1517 * width: Pointer to a variable to be filled in with the width. |
1519 * height Pointer to a variable to be filled in with the height. | 1518 * height: Pointer to a variable to be filled in with the height. |
1520 */ | 1519 */ |
1521 void API dw_font_text_extents_get(HWND handle, HPIXMAP pixmap, char *text, int *width, int *height) | 1520 void API dw_font_text_extents_get(HWND handle, HPIXMAP pixmap, char *text, int *width, int *height) |
1522 { | 1521 { |
1523 } | 1522 } |
1524 | 1523 |
1525 /* Draw a polygon on a window (preferably a render window). | 1524 /* Draw a polygon on a window (preferably a render window). |
1525 * Parameters: | |
1526 * handle: Handle to the window. | |
1527 * pixmap: Handle to the pixmap. (choose only one of these) | |
1528 * fill: Fill box TRUE or FALSE. | |
1529 * npoints: Number of points passed in. | |
1530 * x: Pointer to array of X coordinates. | |
1531 * y: Pointer to array of Y coordinates. | |
1532 */ | |
1533 void API dw_draw_polygon( HWND handle, HPIXMAP pixmap, int fill, int npoints, int *x, int *y ) | |
1534 { | |
1535 } | |
1536 | |
1537 /* Draw a rectangle on a window (preferably a render window). | |
1526 * Parameters: | 1538 * Parameters: |
1527 * handle: Handle to the window. | 1539 * handle: Handle to the window. |
1528 * pixmap: Handle to the pixmap. (choose only one of these) | 1540 * pixmap: Handle to the pixmap. (choose only one of these) |
1529 * fill: Fill box TRUE or FALSE. | 1541 * fill: Fill box TRUE or FALSE. |
1530 * x: X coordinate. | 1542 * x: X coordinate. |
1531 * y: Y coordinate. | 1543 * y: Y coordinate. |
1532 * width: Width of rectangle. | 1544 * width: Width of rectangle. |
1533 * height: Height of rectangle. | 1545 * height: Height of rectangle. |
1534 */ | 1546 */ |
1535 void API dw_draw_polygon( HWND handle, HPIXMAP pixmap, int fill, int npoints, int *x, int *y ) | |
1536 { | |
1537 } | |
1538 | |
1539 /* Draw a rectangle on a window (preferably a render window). | |
1540 * Parameters: | |
1541 * handle: Handle to the window. | |
1542 * pixmap: Handle to the pixmap. (choose only one of these) | |
1543 * fill: Fill box TRUE or FALSE. | |
1544 * x: X coordinate. | |
1545 * y: Y coordinate. | |
1546 * width: Width of rectangle. | |
1547 * height: Height of rectangle. | |
1548 */ | |
1549 void API dw_draw_rect(HWND handle, HPIXMAP pixmap, int fill, int x, int y, int width, int height) | 1547 void API dw_draw_rect(HWND handle, HPIXMAP pixmap, int fill, int x, int y, int width, int height) |
1550 { | 1548 { |
1551 } | 1549 } |
1552 | 1550 |
1553 /* | 1551 /* |
1840 void API dw_filesystem_set_item(HWND handle, void *pointer, int column, int row, void *data) | 1838 void API dw_filesystem_set_item(HWND handle, void *pointer, int column, int row, void *data) |
1841 { | 1839 { |
1842 } | 1840 } |
1843 | 1841 |
1844 /* | 1842 /* |
1845 * Gets column type for a container column | 1843 * Gets column type for a container column. |
1846 * Parameters: | 1844 * Parameters: |
1847 * handle: Handle to the container window (widget). | 1845 * handle: Handle to the container window (widget). |
1848 * column: Zero based column. | 1846 * column: Zero based column. |
1849 * Returns: | 1847 * Returns: |
1850 * Constant identifying the the column type. | 1848 * Constant identifying the the column type. |
1851 */ | 1849 */ |
1852 int API dw_container_get_column_type(HWND handle, int column) | 1850 int API dw_container_get_column_type(HWND handle, int column) |
1853 { | 1851 { |
1854 return 0; | 1852 return 0; |
1855 } | 1853 } |
1856 | 1854 |
1857 /* | 1855 /* |
1858 * Gets column type for a filesystem container column | 1856 * Gets column type for a filesystem container column. |
1859 * Parameters: | 1857 * Parameters: |
1860 * handle: Handle to the container window (widget). | 1858 * handle: Handle to the container window (widget). |
1861 * column: Zero based column. | 1859 * column: Zero based column. |
1862 * Returns: | 1860 * Returns: |
1863 * Constant identifying the the column type. | 1861 * Constant identifying the the column type. |
1864 */ | 1862 */ |
1865 int API dw_filesystem_get_column_type(HWND handle, int column) | 1863 int API dw_filesystem_get_column_type(HWND handle, int column) |
1866 { | 1864 { |
1867 return 0; | 1865 return 0; |
1868 } | 1866 } |
1869 | 1867 |
2052 { | 2050 { |
2053 return 0; | 2051 return 0; |
2054 } | 2052 } |
2055 | 2053 |
2056 /* | 2054 /* |
2057 * Obtains an icon from data | 2055 * Obtains an icon from data. |
2058 * Parameters: | 2056 * Parameters: |
2059 * filename: Name of the file, omit extention to have | 2057 * data: Data for the icon (ICO on OS/2 or Windows, XPM on Unix, PNG on Mac) |
2060 * DW pick the appropriate file extension. | 2058 * len: Length of the passed in data. |
2061 * (ICO on OS/2 or Windows, XPM on Unix) | |
2062 * Returns: | 2059 * Returns: |
2063 * Handle to the created icon or NULL on error. | 2060 * Handle to the created icon or NULL on error. |
2064 */ | 2061 */ |
2065 HICN API dw_icon_load_from_data(char *data, int len) | 2062 HICN API dw_icon_load_from_data(char *data, int len) |
2066 { | 2063 { |
2067 return 0; | 2064 return 0; |
2068 } | 2065 } |
2069 | 2066 |
2070 /* | 2067 /* |
2071 * Frees a loaded resource in OS/2 and Windows. | 2068 * Frees a loaded icon resource. |
2072 * Parameters: | 2069 * Parameters: |
2073 * handle: Handle to icon returned by dw_icon_load(). | 2070 * handle: Handle to icon returned by dw_icon_load(). |
2074 */ | 2071 */ |
2075 void API dw_icon_free(HICN handle) | 2072 void API dw_icon_free(HICN handle) |
2076 { | 2073 { |
2113 | 2110 |
2114 /* | 2111 /* |
2115 * Gets the position of a splitbar (pecentage). | 2112 * Gets the position of a splitbar (pecentage). |
2116 * Parameters: | 2113 * Parameters: |
2117 * handle: The handle to the splitbar returned by dw_splitbar_new(). | 2114 * handle: The handle to the splitbar returned by dw_splitbar_new(). |
2115 * Returns: | |
2116 * Position of the splitbar (percentage). | |
2118 */ | 2117 */ |
2119 float API dw_splitbar_get(HWND handle) | 2118 float API dw_splitbar_get(HWND handle) |
2120 { | 2119 { |
2121 return 0; | 2120 return 0; |
2122 } | 2121 } |
2162 { | 2161 { |
2163 return 0; | 2162 return 0; |
2164 } | 2163 } |
2165 | 2164 |
2166 /* | 2165 /* |
2167 * Creates a pixmap from memory. | 2166 * Creates a pixmap from data in memory. |
2168 * Parameters: | 2167 * Parameters: |
2169 * handle: Window handle the pixmap is associated with. | 2168 * handle: Window handle the pixmap is associated with. |
2170 * data: Source of the image data | 2169 * data: Source of the image data |
2171 * (BMP on OS/2 or Windows, XPM on Unix) | 2170 * (BMP on OS/2 or Windows, XPM on Unix) |
2172 * le: length of data | 2171 * len: Length of data |
2173 * Returns: | 2172 * Returns: |
2174 * A handle to a pixmap or NULL on failure. | 2173 * A handle to a pixmap or NULL on failure. |
2175 */ | 2174 */ |
2176 HPIXMAP API dw_pixmap_new_from_data(HWND handle, char *data, int len) | 2175 HPIXMAP API dw_pixmap_new_from_data(HWND handle, char *data, int len) |
2177 { | 2176 { |
2178 return 0; | 2177 return 0; |
2179 } | 2178 } |
2180 | 2179 |
2181 /* | 2180 /* |
2182 * Sets the transparent color for a pixmap | 2181 * Sets the transparent color for a pixmap. |
2183 * Parameters: | 2182 * Parameters: |
2184 * pixmap: Handle to a pixmap returned by | 2183 * pixmap: Handle to a pixmap returned by |
2185 * dw_pixmap_new.. | 2184 * dw_pixmap_new.. |
2186 * color: transparent color | 2185 * color: Transparent RGB color |
2187 * Note: This is only necessary on platforms that | 2186 * Note: This is only necessary on platforms that |
2188 * don't handle transparency automatically | 2187 * don't handle transparency automatically |
2189 */ | 2188 */ |
2190 void API dw_pixmap_set_transparent_color( HPIXMAP pixmap, ULONG color ) | 2189 void API dw_pixmap_set_transparent_color( HPIXMAP pixmap, ULONG color ) |
2191 { | 2190 { |
2233 } | 2232 } |
2234 | 2233 |
2235 /* | 2234 /* |
2236 * Create a new calendar window (widget) to be packed. | 2235 * Create a new calendar window (widget) to be packed. |
2237 * Parameters: | 2236 * Parameters: |
2238 * text: The text to be display by the static text widget. | |
2239 * id: An ID to be used with dw_window_from_id() or 0L. | 2237 * id: An ID to be used with dw_window_from_id() or 0L. |
2240 * Returns: | 2238 * Returns: |
2241 * Handle to the created calendar or NULL on error. | 2239 * Handle to the created calendar or NULL on error. |
2242 */ | 2240 */ |
2243 HWND API dw_calendar_new(ULONG cid) | 2241 HWND API dw_calendar_new(ULONG cid) |
2306 } | 2304 } |
2307 | 2305 |
2308 /* | 2306 /* |
2309 * Create a new HTML window (widget) to be packed. | 2307 * Create a new HTML window (widget) to be packed. |
2310 * Parameters: | 2308 * Parameters: |
2311 * text: The default text to be in the entryfield widget. | |
2312 * id: An ID to be used with dw_window_from_id() or 0L. | 2309 * id: An ID to be used with dw_window_from_id() or 0L. |
2313 * Returns: | 2310 * Returns: |
2314 * Handle to the created html widget or NULL on error. | 2311 * Handle to the created html widget or NULL on error. |
2315 */ | 2312 */ |
2316 HWND API dw_html_new(unsigned long cid) | 2313 HWND API dw_html_new(unsigned long cid) |
2390 * title: The title text on the menu item to be added. | 2387 * title: The title text on the menu item to be added. |
2391 * id: An ID to be used for message passing. | 2388 * id: An ID to be used for message passing. |
2392 * flags: Extended attributes to set on the menu. | 2389 * flags: Extended attributes to set on the menu. |
2393 * end: If TRUE memu is positioned at the end of the menu. | 2390 * end: If TRUE memu is positioned at the end of the menu. |
2394 * check: If TRUE menu is "check"able. | 2391 * check: If TRUE menu is "check"able. |
2395 * flags: Extended attributes to set on the menu. | |
2396 * submenu: Handle to an existing menu to be a submenu or NULL. | 2392 * submenu: Handle to an existing menu to be a submenu or NULL. |
2397 * Returns: | 2393 * Returns: |
2398 * Handle to the created menu item or NULL on error. | 2394 * Handle to the created menu item or NULL on error. |
2399 */ | 2395 */ |
2400 HWND API dw_menu_append_item(HMENUI menux, char *title, ULONG itemid, ULONG flags, int end, int check, HMENUI submenux) | 2396 HWND API dw_menu_append_item(HMENUI menux, char *title, ULONG itemid, ULONG flags, int end, int check, HMENUI submenux) |
2474 { | 2470 { |
2475 return 0; | 2471 return 0; |
2476 } | 2472 } |
2477 | 2473 |
2478 /* | 2474 /* |
2479 * Sets the currently visibale page ID. | 2475 * Sets the currently visible page ID. |
2480 * Parameters: | 2476 * Parameters: |
2481 * handle: Handle to the notebook widget. | 2477 * handle: Handle to the notebook widget. |
2482 * pageid: ID of the page to be made visible. | 2478 * pageid: ID of the page to be made visible. |
2483 */ | 2479 */ |
2484 void API dw_notebook_page_set(HWND handle, unsigned int pageid) | 2480 void API dw_notebook_page_set(HWND handle, unsigned int pageid) |
2521 /* | 2517 /* |
2522 * Create a new Window Frame. | 2518 * Create a new Window Frame. |
2523 * Parameters: | 2519 * Parameters: |
2524 * owner: The Owner's window handle or HWND_DESKTOP. | 2520 * owner: The Owner's window handle or HWND_DESKTOP. |
2525 * title: The Window title. | 2521 * title: The Window title. |
2526 * flStyle: Style flags, see the PM reference. | 2522 * flStyle: Style flags. |
2527 * Returns: | 2523 * Returns: |
2528 * Handle to the created window or NULL on error. | 2524 * Handle to the created window or NULL on error. |
2529 */ | 2525 */ |
2530 HWND API dw_window_new(HWND hwndOwner, char *title, ULONG flStyle) | 2526 HWND API dw_window_new(HWND hwndOwner, char *title, ULONG flStyle) |
2531 { | 2527 { |
2567 } | 2563 } |
2568 | 2564 |
2569 /* | 2565 /* |
2570 * Makes the window invisible. | 2566 * Makes the window invisible. |
2571 * Parameters: | 2567 * Parameters: |
2572 * handle: The window handle to make visible. | 2568 * handle: The window handle to hide. |
2573 * Returns: | 2569 * Returns: |
2574 * DW_ERROR_NONE (0) on success. | 2570 * DW_ERROR_NONE (0) on success. |
2575 */ | 2571 */ |
2576 int API dw_window_hide(HWND handle) | 2572 int API dw_window_hide(HWND handle) |
2577 { | 2573 { |
2591 { | 2587 { |
2592 return DW_ERROR_GENERAL; | 2588 return DW_ERROR_GENERAL; |
2593 } | 2589 } |
2594 | 2590 |
2595 /* | 2591 /* |
2596 * Sets the font used by a specified window (widget) handle. | 2592 * Sets the border size of a specified window (widget) handle. |
2597 * Parameters: | 2593 * Parameters: |
2598 * handle: The window (widget) handle. | 2594 * handle: The window (widget) handle. |
2599 * border: Size of the window border in pixels. | 2595 * border: Size of the window border in pixels. |
2600 * Returns: | 2596 * Returns: |
2601 * DW_ERROR_NONE (0) on success. | 2597 * DW_ERROR_NONE (0) on success. |
2674 { | 2670 { |
2675 return DW_ERROR_GENERAL; | 2671 return DW_ERROR_GENERAL; |
2676 } | 2672 } |
2677 | 2673 |
2678 /* | 2674 /* |
2679 * Returns the current font for the specified window | 2675 * Returns the current font for the specified window. |
2680 * Parameters: | 2676 * Parameters: |
2681 * handle: The window handle from which to obtain the font. | 2677 * handle: The window handle from which to obtain the font. |
2682 * Returns: | 2678 * Returns: |
2683 * A malloc()ed font name string to be dw_free()ed or NULL on error. | 2679 * A malloc()ed font name string to be dw_free()ed or NULL on error. |
2684 */ | 2680 */ |
2702 /* | 2698 /* |
2703 * Gets the text used for a given window. | 2699 * Gets the text used for a given window. |
2704 * Parameters: | 2700 * Parameters: |
2705 * handle: Handle to the window. | 2701 * handle: Handle to the window. |
2706 * Returns: | 2702 * Returns: |
2707 * text: The text associsated with a given window or NULL on error. | 2703 * The text associsated with a given window or NULL on error. |
2708 */ | 2704 */ |
2709 char * API dw_window_get_text(HWND handle) | 2705 char * API dw_window_get_text(HWND handle) |
2710 { | 2706 { |
2711 return NULL; | 2707 return NULL; |
2712 } | 2708 } |
2734 * Enables given window (widget). | 2730 * Enables given window (widget). |
2735 * Parameters: | 2731 * Parameters: |
2736 * handle: Handle to the window. | 2732 * handle: Handle to the window. |
2737 */ | 2733 */ |
2738 void API dw_window_enable(HWND handle) | 2734 void API dw_window_enable(HWND handle) |
2735 { | |
2736 } | |
2737 | |
2738 /* | |
2739 * Sets the bitmap used for a given static window. | |
2740 * Parameters: | |
2741 * handle: Handle to the window. | |
2742 * id: An ID to be used to specify the icon, | |
2743 * (pass 0 if you use the filename param) | |
2744 * data: memory buffer containing image (Bitmap on OS/2 or | |
2745 * Windows and a pixmap on Unix, pass | |
2746 * NULL if you use the id param) | |
2747 * len: Length of data passed | |
2748 */ | |
2749 void API dw_window_set_bitmap_from_data(HWND handle, unsigned long cid, char *data, int len) | |
2739 { | 2750 { |
2740 } | 2751 } |
2741 | 2752 |
2742 /* | 2753 /* |
2743 * Sets the bitmap used for a given static window. | 2754 * Sets the bitmap used for a given static window. |
2747 * (pass 0 if you use the filename param) | 2758 * (pass 0 if you use the filename param) |
2748 * filename: a path to a file (Bitmap on OS/2 or | 2759 * filename: a path to a file (Bitmap on OS/2 or |
2749 * Windows and a pixmap on Unix, pass | 2760 * Windows and a pixmap on Unix, pass |
2750 * NULL if you use the id param) | 2761 * NULL if you use the id param) |
2751 */ | 2762 */ |
2752 void API dw_window_set_bitmap_from_data(HWND handle, unsigned long cid, char *data, int len) | 2763 void API dw_window_set_bitmap(HWND handle, unsigned long resid, char *filename) |
2753 { | 2764 { |
2754 } | 2765 } |
2755 | 2766 |
2756 /* | 2767 /* |
2757 * Sets the bitmap used for a given static window. | 2768 * Sets the icon used for a given window. |
2758 * Parameters: | 2769 * Parameters: |
2759 * handle: Handle to the window. | 2770 * handle: Handle to the window. |
2760 * id: An ID to be used to specify the icon, | 2771 * icon: Handle to icon to be used. |
2761 * (pass 0 if you use the filename param) | |
2762 * filename: a path to a file (Bitmap on OS/2 or | |
2763 * Windows and a pixmap on Unix, pass | |
2764 * NULL if you use the id param) | |
2765 */ | |
2766 void API dw_window_set_bitmap(HWND handle, unsigned long resid, char *filename) | |
2767 { | |
2768 } | |
2769 | |
2770 /* | |
2771 * Sets the icon used for a given window. | |
2772 * Parameters: | |
2773 * handle: Handle to the window. | |
2774 * id: An ID to be used to specify the icon. | |
2775 */ | 2772 */ |
2776 void API dw_window_set_icon(HWND handle, HICN icon) | 2773 void API dw_window_set_icon(HWND handle, HICN icon) |
2777 { | 2774 { |
2778 } | 2775 } |
2779 | 2776 |
2896 int API dw_screen_height(void) | 2893 int API dw_screen_height(void) |
2897 { | 2894 { |
2898 return 0; | 2895 return 0; |
2899 } | 2896 } |
2900 | 2897 |
2901 /* This should return the current color depth */ | 2898 /* This should return the current color depth. */ |
2902 unsigned long API dw_color_depth_get(void) | 2899 unsigned long API dw_color_depth_get(void) |
2903 { | 2900 { |
2904 return 0; | 2901 return 0; |
2905 } | 2902 } |
2906 | 2903 |
2943 } | 2940 } |
2944 | 2941 |
2945 /* | 2942 /* |
2946 * Add a named user data item to a window handle. | 2943 * Add a named user data item to a window handle. |
2947 * Parameters: | 2944 * Parameters: |
2948 * window: Window handle of signal to be called back. | 2945 * window: Window handle to save data to. |
2949 * dataname: A string pointer identifying which signal to be hooked. | 2946 * dataname: A string pointer identifying which data to be saved. |
2950 * data: User data to be passed to the handler function. | 2947 * data: User data to be saved to the window handle. |
2951 */ | 2948 */ |
2952 void dw_window_set_data(HWND window, char *dataname, void *data) | 2949 void dw_window_set_data(HWND window, char *dataname, void *data) |
2953 { | 2950 { |
2954 } | 2951 } |
2955 | 2952 |
2956 /* | 2953 /* |
2957 * Gets a named user data item to a window handle. | 2954 * Gets a named user data item from a window handle. |
2958 * Parameters: | 2955 * Parameters: |
2959 * window: Window handle of signal to be called back. | 2956 * window: Window handle to get data from. |
2960 * dataname: A string pointer identifying which signal to be hooked. | 2957 * dataname: A string pointer identifying which data to get. |
2961 * data: User data to be passed to the handler function. | 2958 * Returns: |
2962 * Returns: | |
2963 * Pointer to data or NULL if no data is available. | 2959 * Pointer to data or NULL if no data is available. |
2964 */ | 2960 */ |
2965 void *dw_window_get_data(HWND window, char *dataname) | 2961 void *dw_window_get_data(HWND window, char *dataname) |
2966 { | 2962 { |
2967 return NULL; | 2963 return NULL; |
2968 } | 2964 } |
2969 | 2965 |
3162 /* | 3158 /* |
3163 * Waits on a semaphore created by dw_event_new(), until the | 3159 * Waits on a semaphore created by dw_event_new(), until the |
3164 * event gets posted or until the timeout expires. | 3160 * event gets posted or until the timeout expires. |
3165 * Parameters: | 3161 * Parameters: |
3166 * eve: The handle to the event returned by dw_event_new(). | 3162 * eve: The handle to the event returned by dw_event_new(). |
3163 * timeout: Number of milliseconds before timing out | |
3164 * or -1 if indefinite. | |
3167 * Returns: | 3165 * Returns: |
3168 * DW_ERROR_NONE (0) on success. | 3166 * DW_ERROR_NONE (0) on success. |
3169 * DW_ERROR_TIMEOUT (2) if the timeout has expired. | 3167 * DW_ERROR_TIMEOUT (2) if the timeout has expired. |
3170 * Other values on other error. | 3168 * Other values on other error. |
3171 */ | 3169 */ |
3184 int dw_event_close(HEV *eve) | 3182 int dw_event_close(HEV *eve) |
3185 { | 3183 { |
3186 return DW_ERROR_GENERAL; | 3184 return DW_ERROR_GENERAL; |
3187 } | 3185 } |
3188 | 3186 |
3189 /* Using domain sockets on unix for IPC */ | |
3190 /* Create a named event semaphore which can be | 3187 /* Create a named event semaphore which can be |
3191 * opened from other processes. | 3188 * opened from other processes. |
3192 * Parameters: | 3189 * Parameters: |
3193 * eve: Pointer to an event handle to receive handle. | |
3194 * name: Name given to semaphore which can be opened | 3190 * name: Name given to semaphore which can be opened |
3195 * by other processes. | 3191 * by other processes. |
3196 * Returns: | 3192 * Returns: |
3197 * Handle to event semaphore or NULL on error. | 3193 * Handle to event semaphore or NULL on error. |
3198 */ | 3194 */ |
3201 return NULL; | 3197 return NULL; |
3202 } | 3198 } |
3203 | 3199 |
3204 /* Open an already existing named event semaphore. | 3200 /* Open an already existing named event semaphore. |
3205 * Parameters: | 3201 * Parameters: |
3206 * eve: Pointer to an event handle to receive handle. | |
3207 * name: Name given to semaphore which can be opened | 3202 * name: Name given to semaphore which can be opened |
3208 * by other processes. | 3203 * by other processes. |
3209 * Returns: | 3204 * Returns: |
3210 * Handle to event semaphore or NULL on error. | 3205 * Handle to event semaphore or NULL on error. |
3211 */ | 3206 */ |
3216 | 3211 |
3217 /* Resets the event semaphore so threads who call wait | 3212 /* Resets the event semaphore so threads who call wait |
3218 * on this semaphore will block. | 3213 * on this semaphore will block. |
3219 * Parameters: | 3214 * Parameters: |
3220 * eve: Handle to the semaphore obtained by | 3215 * eve: Handle to the semaphore obtained by |
3221 * an open or create call. | 3216 * an get or new call. |
3222 * Returns: | 3217 * Returns: |
3223 * DW_ERROR_NONE (0) on success. | 3218 * DW_ERROR_NONE (0) on success. |
3224 */ | 3219 */ |
3225 int dw_named_event_reset(HEV eve) | 3220 int dw_named_event_reset(HEV eve) |
3226 { | 3221 { |
3229 | 3224 |
3230 /* Sets the posted state of an event semaphore, any threads | 3225 /* Sets the posted state of an event semaphore, any threads |
3231 * waiting on the semaphore will no longer block. | 3226 * waiting on the semaphore will no longer block. |
3232 * Parameters: | 3227 * Parameters: |
3233 * eve: Handle to the semaphore obtained by | 3228 * eve: Handle to the semaphore obtained by |
3234 * an open or create call. | 3229 * an get or new call. |
3235 * Returns: | 3230 * Returns: |
3236 * DW_ERROR_NONE (0) on success. | 3231 * DW_ERROR_NONE (0) on success. |
3237 */ | 3232 */ |
3238 int dw_named_event_post(HEV eve) | 3233 int dw_named_event_post(HEV eve) |
3239 { | 3234 { |
3242 | 3237 |
3243 /* Waits on the specified semaphore until it becomes | 3238 /* Waits on the specified semaphore until it becomes |
3244 * posted, or returns immediately if it already is posted. | 3239 * posted, or returns immediately if it already is posted. |
3245 * Parameters: | 3240 * Parameters: |
3246 * eve: Handle to the semaphore obtained by | 3241 * eve: Handle to the semaphore obtained by |
3247 * an open or create call. | 3242 * an get or new call. |
3248 * timeout: Number of milliseconds before timing out | 3243 * timeout: Number of milliseconds before timing out |
3249 * or -1 if indefinite. | 3244 * or -1 if indefinite. |
3250 * Returns: | 3245 * Returns: |
3251 * DW_ERROR_NONE (0) on success. | 3246 * DW_ERROR_NONE (0) on success. |
3252 */ | 3247 */ |
3257 | 3252 |
3258 /* Release this semaphore, if there are no more open | 3253 /* Release this semaphore, if there are no more open |
3259 * handles on this semaphore the semaphore will be destroyed. | 3254 * handles on this semaphore the semaphore will be destroyed. |
3260 * Parameters: | 3255 * Parameters: |
3261 * eve: Handle to the semaphore obtained by | 3256 * eve: Handle to the semaphore obtained by |
3262 * an open or create call. | 3257 * an get or new call. |
3263 * Returns: | 3258 * Returns: |
3264 * DW_ERROR_NONE (0) on success. | 3259 * DW_ERROR_NONE (0) on success. |
3265 */ | 3260 */ |
3266 int dw_named_event_close(HEV eve) | 3261 int dw_named_event_close(HEV eve) |
3267 { | 3262 { |
3284 } | 3279 } |
3285 | 3280 |
3286 /* | 3281 /* |
3287 * Allocates a shared memory region with a name. | 3282 * Allocates a shared memory region with a name. |
3288 * Parameters: | 3283 * Parameters: |
3289 * handle: A pointer to receive a SHM identifier. | |
3290 * dest: A pointer to a pointer to receive the memory address. | 3284 * dest: A pointer to a pointer to receive the memory address. |
3291 * size: Size in bytes of the shared memory region to allocate. | 3285 * size: Size in bytes of the shared memory region to allocate. |
3292 * name: A string pointer to a unique memory name. | 3286 * name: A string pointer to a unique memory name. |
3293 * Returns: | 3287 * Returns: |
3294 * Handle to shared memory or NULL on error. | 3288 * Handle to shared memory or NULL on error. |
3313 } | 3307 } |
3314 | 3308 |
3315 /* | 3309 /* |
3316 * Frees a shared memory region previously allocated. | 3310 * Frees a shared memory region previously allocated. |
3317 * Parameters: | 3311 * Parameters: |
3318 * handle: Handle obtained from DB_named_memory_allocate. | 3312 * handle: Handle obtained from dw_named_memory_new(). |
3319 * ptr: The memory address aquired with DB_named_memory_allocate. | 3313 * ptr: The memory address aquired with dw_named_memory_new(). |
3320 * Returns: | 3314 * Returns: |
3321 * DW_ERROR_NONE (0) on success or DW_ERROR_UNKNOWN (-1) on error. | 3315 * DW_ERROR_NONE (0) on success or DW_ERROR_UNKNOWN (-1) on error. |
3322 */ | 3316 */ |
3323 int dw_named_memory_free(HSHM handle, void *ptr) | 3317 int dw_named_memory_free(HSHM handle, void *ptr) |
3324 { | 3318 { |