FSH CHECKEANAME: Difference between revisions
Created page with "Check extended attribute name validity. ==Syntax== FSH_CHECKEANAME(iLevel, cbEAName, szEAName) ==Parameters== ;iLevel: is the extended attributes name checking level. ..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
Check extended attribute name validity. | Check extended attribute name validity. | ||
==Syntax== | ==Syntax== | ||
FSH_CHECKEANAME(iLevel, cbEAName, szEAName) | FSH_CHECKEANAME(iLevel, cbEAName, szEAName) | ||
==Parameters== | ==Parameters== | ||
;iLevel: is the extended attributes name checking level. | ;iLevel: is the extended attributes name checking level. | ||
:iLevel = 0x0001 indicates OS/2 Version 2.0 name checking. | |||
;cbEAName: is the length of the extended attribute name, not including terminating NUL. | |||
;szEAName: is the extended attribute name to check for validity. | |||
==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_INVALID_NAME : pathname contains invalid or wildcard characters, or is too long. | |||
*ERROR_INVALID_PARAMETER : invalid level. | |||
==Calling Sequence== | ==Calling Sequence== | ||
<PRE> | <PRE> | ||
| Line 27: | Line 23: | ||
char far * szEAName; | char far * szEAName; | ||
</PRE> | </PRE> | ||
==Remarks== | ==Remarks== | ||
This routine processes DBCS characters properly. | This routine processes DBCS characters properly. | ||
The set of invalid characters for EA names is the same as that for filenames . In OS/2 Version 2.0, the maximum length of an EA name, not including the terminating NUL, is 255 bytes. The minimum length is 1 byte. | The set of invalid characters for EA names is the same as that for filenames. In OS/2 Version 2.0, the maximum length of an EA name, not including the terminating NUL, is 255 bytes. The minimum length is 1 byte. | ||
The FSD is responsible for verifying the string pointers and checking for segment boundaries. | The FSD is responsible for verifying the string pointers and checking for segment boundaries. | ||
FSH_CHECKEANAME should be called for extended attribute names passed to the FSD. | FSH_CHECKEANAME should be called for extended attribute names passed to the FSD. | ||
;Note: OS/2 does not validate input parameters. Therefore, an FSD should call FSH_PROBEBUF where appropriate. | ;Note: OS/2 does not validate input parameters. Therefore, an FSD should call FSH_PROBEBUF where appropriate. | ||
[[Category:IFS Interfaces]] | [[Category:IFS Interfaces]] | ||
{{DISPLAYTITLE:FSH_CHECKEANAME}} | {{DISPLAYTITLE:FSH_CHECKEANAME}} | ||
Latest revision as of 17:19, 12 February 2020
Check extended attribute name validity.
Syntax
FSH_CHECKEANAME(iLevel, cbEAName, szEAName)
Parameters
- iLevel
- is the extended attributes name checking level.
- iLevel = 0x0001 indicates OS/2 Version 2.0 name checking.
- cbEAName
- is the length of the extended attribute name, not including terminating NUL.
- szEAName
- is the extended attribute name to check for validity.
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_INVALID_NAME : pathname contains invalid or wildcard characters, or is too long.
- ERROR_INVALID_PARAMETER : invalid level.
Calling Sequence
int far pascal FSH_CHECKEANAME(iLevel, cbEAName, szEAName) unsigned short iLevel; unsigned long cbEAName; char far * szEAName;
Remarks
This routine processes DBCS characters properly.
The set of invalid characters for EA names is the same as that for filenames. In OS/2 Version 2.0, the maximum length of an EA name, not including the terminating NUL, is 255 bytes. The minimum length is 1 byte.
The FSD is responsible for verifying the string pointers and checking for segment boundaries.
FSH_CHECKEANAME should be called for extended attribute names passed to the FSD.
- Note
- OS/2 does not validate input parameters. Therefore, an FSD should call FSH_PROBEBUF where appropriate.