FSH SETVOLUME: Difference between revisions
Created page with "This function provides the mechanism for assuring that a desired volume is in a removable media drive before I/O is done to the drive. ==Syntax== FSH_SETVOLUME(hVPB , fCo..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This function provides the mechanism for assuring that a desired volume is in a removable media drive before I/O is done to the drive. | This function provides the mechanism for assuring that a desired volume is in a removable media drive before I/O is done to the drive. | ||
==Syntax== | ==Syntax== | ||
FSH_SETVOLUME(hVPB, fControl) | |||
==Parameters== | ==Parameters== | ||
;hVPB: is the volume handle for the source of I/O. | ;hVPB: is the volume handle for the source of I/O. | ||
;fControl] is the bit mask of pop-up control actions: | |||
;fControl] is the bit mask of pop-up control actions: | :*Bit 0 off indicates volume change pop-up desired | ||
:*Bit 0 on indicates no volume change pop-up | |||
:All other bits are reserved and must be zero. | |||
==Returns== | ==Returns== | ||
If no error is detected, a zero error code is returned. If an error is detected, one of the following error codes is returned: | If no error is detected, a zero error code is returned. If an error is detected, one of the following error codes is returned: | ||
* ERROR_VOLUME_CHANGED is an indication that removable media volume change has occurred. | * ERROR_VOLUME_CHANGED is an indication that removable media volume change has occurred. | ||
* ERROR_INVALID_PARAMETER the fControl flag word has reserved bits on. | |||
==Calling Sequence== | ==Calling Sequence== | ||
<PRE> | <PRE> | ||
int far pascal FSH_SETVOLUME(hVPB, fControl) | |||
int far pascal FSH_SETVOLUME(hVPB , fControl) | |||
unsigned short hVPB; | unsigned short hVPB; | ||
unsigned short fControl; | unsigned short fControl; | ||
</PRE> | |||
==Remarks== | ==Remarks== | ||
This routine is used by the FSH_CALLDRIVER routine to insure that the desired volume is in a removable media drive. FSDs can use it for the same purpose. | This routine is used by the FSH_CALLDRIVER routine to insure that the desired volume is in a removable media drive. FSDs can use it for the same purpose. | ||
FSH_SETVOLUME may block. | FSH_SETVOLUME may block. | ||
;Note: OS/2 does not validate input parameters. An FSD, therefore, should call FSH_PROBEBUF where appropriate. | ;Note: OS/2 does not validate input parameters. An FSD, therefore, should call FSH_PROBEBUF where appropriate. | ||
[[Category:IFS Interfaces]] | [[Category:IFS Interfaces]] | ||
{{DISPLAYTITLE:FSH_SETVOLUME}} | {{DISPLAYTITLE:FSH_SETVOLUME}} | ||
Latest revision as of 07:08, 20 February 2020
This function provides the mechanism for assuring that a desired volume is in a removable media drive before I/O is done to the drive.
Syntax
FSH_SETVOLUME(hVPB, fControl)
Parameters
- hVPB
- is the volume handle for the source of I/O.
- fControl] is the bit mask of pop-up control actions
-
- Bit 0 off indicates volume change pop-up desired
- Bit 0 on indicates no volume change pop-up
- All other bits are reserved and must be zero.
Returns
If no error is detected, a zero error code is returned. If an error is detected, one of the following error codes is returned:
- ERROR_VOLUME_CHANGED is an indication that removable media volume change has occurred.
- ERROR_INVALID_PARAMETER the fControl flag word has reserved bits on.
Calling Sequence
int far pascal FSH_SETVOLUME(hVPB, fControl) unsigned short hVPB; unsigned short fControl;
Remarks
This routine is used by the FSH_CALLDRIVER routine to insure that the desired volume is in a removable media drive. FSDs can use it for the same purpose.
FSH_SETVOLUME may block.
- Note
- OS/2 does not validate input parameters. An FSD, therefore, should call FSH_PROBEBUF where appropriate.